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.
event_typeslist of enumsRequired
Event types to send. Must explicitly include all event types to receive.
Allowed values:
inbox_idslist of stringsOptional
Inbox IDs 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.
enabledboolean
Whether the webhook is enabled.
updated_atdatetime
Time at which webhook was last updated.
created_atdatetime
Time at which webhook was created.
event_typeslist of enums or null
Event types to send. Must explicitly include all event types to receive.
Allowed values:
inbox_idslist of strings or null
Inbox IDs for which to send events. Omit to send events for all inboxes.

Errors