Create a subscription

Use this endpoint to subscribe to a webhook.

Verification handshake - when a subscription is created, the API sends a POST request to the target_url with an X-Hook-Secret header. Your endpoint must respond with the same X-Hook-Secret header and value. If the secret is not echoed back the request fails with a 401 error, and if the target_url cannot be reached it fails with a 400 error.

A target_url that is already used by another subscription is rejected with a 409 error. Sandbox API keys cannot create subscriptions and receive a 403 error.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

This value must be unique, you may not specify the same target url for more than one webhook.

string
required

Allowed values:

agent.created, agent.updated, agent.deleted, client.created, client.updated, client.deleted, search.created, search.updated, search.deleted, search.match.created, search.match.updated, message.created,listing.created, listing.updated, listing.deleted, favorite.created, favorite.deleted

configuration
object

Configuration options for the webhook. Unknown properties are rejected with a 400 error.

Responses

403

Webhooks are not enabled for this API key, or the API key is a sandbox key. Contact the Repliers support team to enable the feature.

409

The target_url is already used by another webhook subscription.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json