Objekt

WebhookEndpoint

Fält

idintegerobligatorisk
urlstringobligatorisk
descriptionstringobligatorisk
eventsarray of WebhookEventFilterobligatorisk
activebooleanobligatorisk
statusWebhookStatusobligatorisk
paused_atstring (date-time) | null
paused_reasonstring | null
failures: 10 misslyckade försök i rad; feature_disabled: prisplanen omfattar inte webhookar.
disabled_reasonstring | null
gone: mottagaren svarade 410; manual: inaktiverad av en administratör.
Tillåtna värden: gonemanualnull
disabled_atstring (date-time) | null
roleWebhookRoleobligatorisk
data_profile_idinteger | null
Webhookens dataprofil (null betyder ingen profil, som för en API-nyckel med samma roll).
collection_idsarray of integerobligatorisk
Samlingar som webhooken tar emot händelser om; tomt betyder alla samlingar som rollen och dataprofilen har tillgång till.
tagsarray of stringobligatorisk
Korthändelser bara för kort med någon av dessa taggar; tomt betyder inget filter.
payloadWebhookPayloadModeobligatorisk
headersarray of WebhookHeaderobligatorisk
auth_typestring | null
Typ av utgående auktorisering (null betyder ingen).
Tillåtna värden: bearerbasicnull
auth_setbooleanobligatorisk
Om utgående auktorisering är angiven (värdena returneras aldrig).
previous_secret_valid_untilstring (date-time) | null
Till när leveranserna också signeras med den tidigare hemligheten (null betyder att det inte finns någon överlappning).
healthWebhookHealth
consecutive_failuresintegerobligatorisk
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)obligatorisk
updated_atstring (date-time)obligatorisk

Används av

Ingår i

WebhookCreated WebhookEndpointList