Objecten

WebhookEndpoint

Velden

idintegerverplicht
urlstringverplicht
descriptionstringverplicht
eventsarray of WebhookEventFilterverplicht
activebooleanverplicht
statusWebhookStatusverplicht
paused_atstring (date-time) | null
paused_reasonstring | null
failures: 10 mislukte pogingen op rij; feature_disabled: het abonnement omvat geen webhooks.
disabled_reasonstring | null
gone: de ontvanger antwoordde met 410; manual: uitgeschakeld door een beheerder.
Toegestane waarden: gonemanualnull
disabled_atstring (date-time) | null
roleWebhookRoleverplicht
data_profile_idinteger | null
Dataprofiel van de webhook (null betekent geen profiel, zoals bij een API-sleutel met dezelfde rol).
collection_idsarray of integerverplicht
Collecties waarover de webhook events ontvangt; leeg betekent alle collecties die beschikbaar zijn voor de rol en het dataprofiel.
tagsarray of stringverplicht
Events over kaarten alleen voor kaarten met een van deze tags; leeg betekent geen filter.
payloadWebhookPayloadModeverplicht
headersarray of WebhookHeaderverplicht
auth_typestring | null
Type van de uitgaande autorisatie (null betekent geen).
Toegestane waarden: bearerbasicnull
auth_setbooleanverplicht
Of er een uitgaande autorisatie is ingesteld (de waarden worden nooit teruggegeven).
previous_secret_valid_untilstring (date-time) | null
Tot wanneer leveringen ook met het vorige geheim worden ondertekend (null betekent dat er geen overlap is).
healthWebhookHealth
consecutive_failuresintegerverplicht
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)verplicht
updated_atstring (date-time)verplicht

Gebruikt door

Onderdeel van

WebhookCreated WebhookEndpointList