API ReferenceWebhooks

Update Webhook

Authentication

AuthorizationBearer

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

Path parameters

webhook_idstringRequired
ID of webhook.

Request

This endpoint expects an object.
add_inbox_idslist of stringsOptional
Inbox IDs to subscribe to the webhook.
remove_inbox_idslist of stringsOptional
Inbox IDs to unsubscribe from the webhook.
add_pod_idslist of stringsOptional
Pod IDs to subscribe to the webhook.
remove_pod_idslist of stringsOptional
Pod IDs to unsubscribe from the webhook.

Response

This endpoint returns an object.
webhook_idstring
ID of webhook.
urlstring
URL of webhook endpoint.
secretstring
Secret for webhook signature verification.
enabledboolean
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 for which to send events.
pod_idslist of strings or null
Pods for which to send events. Maximum 10 per webhook.
inbox_idslist of strings or null
Inboxes for which to send events. Maximum 10 per webhook.
client_idstring or null
Client ID of webhook.

Errors