Objects

WebhookEndpoint

Fields

idintegerrequired
urlstringrequired
descriptionstringrequired
eventsarray of WebhookEventFilterrequired
activebooleanrequired
statusWebhookStatusrequired
paused_atstring (date-time) | null
paused_reasonstring | null
failures: 10 failed attempts in a row; feature_disabled: the plan does not include webhooks.
disabled_reasonstring | null
gone: the receiver answered 410; manual: disabled by an admin.
Allowed values: gonemanualnull
disabled_atstring (date-time) | null
roleWebhookRolerequired
data_profile_idinteger | null
Data profile of the webhook (null means no profile, as for an API key with the same role).
collection_idsarray of integerrequired
Collections the webhook receives events about; empty means all collections available to the role and the data profile.
tagsarray of stringrequired
Card events only for cards with any of these tags; empty means no filter.
payloadWebhookPayloadModerequired
headersarray of WebhookHeaderrequired
auth_typestring | null
Type of the outbound authorization (null means none).
Allowed values: bearerbasicnull
auth_setbooleanrequired
Whether outbound authorization is set (the values are never returned).
previous_secret_valid_untilstring (date-time) | null
Until when deliveries are also signed with the previous secret (null means there is no overlap).
healthWebhookHealth
consecutive_failuresintegerrequired
last_delivery_atstring (date-time) | null
last_success_atstring (date-time) | null
last_errorstring | null
created_byinteger | null
created_by_namestring | null
created_atstring (date-time)required
updated_atstring (date-time)required

Used by

Part of

WebhookCreated WebhookEndpointList