Objekty

WebhookEndpoint

Pole

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

  failures: 10 neúspěšných pokusů za sebou; feature_disabled: tarif nezahrnuje webhooky.

• disabled_reasonstring | null

  gone: příjemce odpověděl 410; manual: vypnuto administrátorem.

  Povolené hodnoty: gonemanualnull

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

  Datový profil webhooku (null znamená bez profilu, stejně jako u klíče API se stejnou rolí).

• collection_idsarray of integerpovinné

  Kolekce, o kterých webhook dostává události; prázdné znamená všechny kolekce dostupné roli a datovému profilu.

• tagsarray of stringpovinné

  Události karet jen u karet s některým z těchto štítků; prázdné znamená bez filtru.

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

  Typ odchozí autorizace (null znamená žádná).

  Povolené hodnoty: bearerbasicnull

• auth_setbooleanpovinné

  Zda je odchozí autorizace nastavena (hodnoty se nikdy nevracejí).

• previous_secret_valid_untilstring (date-time) | null

  Do kdy se doručení podepisují i předchozím tajným klíčem (null znamená, že překryv neexistuje).

• 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žívá

• GET/v1/webhooks/{webhook_id}Získat webhook
• PATCH/v1/webhooks/{webhook_id}Aktualizovat webhook
• POST/v1/webhooks/{webhook_id}/revoke-previous-secretOdvolat předchozí tajný klíč
• POST/v1/webhooks/{webhook_id}/resumeObnovit webhook

Součást

WebhookCreatedWebhookEndpointList