API ReferenceWebhooks

Create Webhook

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
urlstringRequired
URL of webhook endpoint.
eventslist of enumsRequired
Event types to send. Must explicitly include all event types to receive.
Allowed values:
inboxeslist of stringsOptional
Inboxes for which to send events. Omit to send events for all inboxes.

Response

This endpoint returns an object.
webhook_idstring
ID of webhook.
urlstring
URL of webhook endpoint.
secretstring
Secret for webhook signature verification.
created_atdatetime
Time at which webhook was created.
eventslist of enumsOptional
Event types to send. Must explicitly include all event types to receive.
Allowed values:
inboxeslist of stringsOptional
Inboxes for which to send events. Omit to send events for all inboxes.

Errors