Objekty

WebhookEndpoint

Polia

• idintegerpovinné
• urlstringpovinné
• descriptionstringpovinné
• eventsarray of WebhookEventFilterpovinné
• activebooleanpovinné
• statusWebhookStatuspovinné
• paused_atstring (date-time) | null
• paused_reasonstring | null

  failures: 10 neúspešných pokusov za sebou; feature_disabled: tarifa nezahŕňa webhooky.

• disabled_reasonstring | null

  gone: príjemca odpovedal 410; manual: vypnuté administrátorom.

  Povolené hodnoty: gonemanualnull

• disabled_atstring (date-time) | null
• roleWebhookRolepovinné
• data_profile_idinteger | null

  Dátový profil webhooku (null znamená bez profilu, ako pri kľúči API s rovnakou rolou).

• collection_idsarray of integerpovinné

  Kolekcie, o ktorých webhook dostáva udalosti; prázdne znamená všetky kolekcie dostupné pre rolu a dátový profil.

• tagsarray of stringpovinné

  Udalosti kariet len pre karty s niektorým z týchto štítkov; prázdne znamená bez filtra.

• payloadWebhookPayloadModepovinné
• headersarray of WebhookHeaderpovinné
• auth_typestring | null

  Typ odchádzajúcej autorizácie (null znamená žiadna).

  Povolené hodnoty: bearerbasicnull

• auth_setbooleanpovinné

  Či je odchádzajúca autorizácia nastavená (hodnoty sa nikdy nevracajú).

• previous_secret_valid_untilstring (date-time) | null

  Dokedy sa doručenia podpisujú aj predchádzajúcim tajným kľúčom (null znamená, že prekryv nie je).

• healthWebhookHealth
• consecutive_failuresintegerpovinné
• 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)povinné
• updated_atstring (date-time)povinné

Používa

• GET/v1/webhooks/{webhook_id}Získať webhook
• PATCH/v1/webhooks/{webhook_id}Upraviť webhook
• POST/v1/webhooks/{webhook_id}/revoke-previous-secretOdvolať predchádzajúci tajný kľúč
• POST/v1/webhooks/{webhook_id}/resumeObnoviť webhook

Súčasť

WebhookCreatedWebhookEndpointList