Hopp til innholdet
Sursa Developers

Objekter

WebhookCreated

Felt

  • idintegerobligatorisk
  • urlstringobligatorisk
  • descriptionstringobligatorisk
  • eventsarray of WebhookEventFilterobligatorisk
  • activebooleanobligatorisk
  • statusWebhookStatusobligatorisk
  • paused_atstring (date-time) | null
  • paused_reasonstring | null

    failures: 10 mislykkede forsøk på rad; feature_disabled: prisplanen inneholder ikke webhooks.

  • disabled_reasonstring | null

    gone: mottakeren svarte 410; manual: deaktivert av en administrator.

    Tillatte verdier: gonemanualnull

  • disabled_atstring (date-time) | null
  • roleWebhookRoleobligatorisk
  • data_profile_idinteger | null

    Webhookens dataprofil (null betyr ingen profil, som for en API-nøkkel med den samme rollen).

  • collection_idsarray of integerobligatorisk

    Samlinger som webhooken mottar hendelser om; tom betyr alle samlinger som er tilgjengelige for rollen og dataprofilen.

  • tagsarray of stringobligatorisk

    Hendelser om kort bare for kort med en av disse taggene; tom betyr ingen filtrering.

  • payloadWebhookPayloadModeobligatorisk
  • headersarray of WebhookHeaderobligatorisk
  • auth_typestring | null

    Typen utgående autorisasjon (null betyr ingen).

    Tillatte verdier: bearerbasicnull

  • auth_setbooleanobligatorisk

    Om utgående autorisasjon er angitt (verdiene returneres aldri).

  • previous_secret_valid_untilstring (date-time) | null

    Hvor lenge leveranser også signeres med den forrige hemmeligheten (null betyr at det ikke finnes noe overlapp).

  • 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
  • secretstringobligatorisk

    whsec_ etterfulgt av 32 byte i base64 (nye hemmeligheter bruker standardalfabetet med utfylling, eldre bruker base64url). Lagre den hos mottakeren; den vises aldri igjen i svar fra API-et. Signeringsnøkkelen etter Standard Webhooks er base64-dekodingen av delen etter whsec_.

  • previous_valid_untilstring (date-time) | null

    Hvor lenge den forrige hemmeligheten fortsatt godtas (etter en rotasjon). null ved opprettelsen.

Brukes av