Webhook

Update a webhook

Update a webhook information

PUT /v1/webhooks/{id}
Basic auth

Path parameters

· 1
id string · uuid required

Unique identifier for the webhook.

Body

· UpdateWebhookRequest
application/json

Updated webhook object.

url string · uri required

URL to which the webhook notification will be delivered.

events array of string required

Event type for which webhook will send the notification.

values

  • ACCOUNTS.CONNECTED
  • ACCOUNTS.DISCONNECTED
  • PROFILES.ADDED
  • PROFILES.UPDATED
  • PROFILES_AUDIENCE.ADDED
  • PROFILES_AUDIENCE.UPDATED
is_active boolean · default: true

true if webhook should be set to active else false.

Note:
If 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.

name string · min length: 1· max length: 100 required

Reference name for the webhook

Responses