API References

WebhookResponse

Schema

Webhook object represents an endpoint, on which webhook notifications will be delivered.

Fields

· 7
url string · uri required

URL to which webhook notifications will be delivered.

id string · uuid required

Unique ID of the webhook.

created_at string · date-time required

UTC date and time of the object, when it was created, in ISO 8601 format.

updated_at string · date-time required

UTC date and time of the object, when it was updated recently, in ISO 8601 format.

is_active boolean · default: true required

true if webhook is active else false.

Note:
If it fails to deliver the webhook in 3 attempts then it sets is_active to false and will not deliver notifications until you fix it and update the status by invoking the PUT /v1/webhooks/{webhook_id} API.

events array of string required

Event type for which the webhook notification is delivered

values

  • ACCOUNTS.CONNECTED
  • ACCOUNTS.DISCONNECTED
  • PROFILES.ADDED
  • PROFILES.UPDATED
  • PROFILES_AUDIENCE.ADDED
  • PROFILES_AUDIENCE.UPDATED
name string · min length: 1· max length: 100 required

Reference name for the webhook

Used by

· 4 operations
GET Retrieve a webhookPUT Update a webhookGET Retrieve all webhooksPOST Create a webhook