Hoppa till innehållet
Sursa Developers

Objekt

WebhookCreated

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

    whsec_ följt av 32 byte i base64 (nya hemligheter använder standardalfabetet med utfyllnad, äldre använder base64url). Spara den hos mottagaren; den visas aldrig mer i API:ets svar. Signeringsnyckeln enligt Standard Webhooks är base64-avkodningen av delen efter whsec_.

  • previous_valid_untilstring (date-time) | null

    Till när den tidigare hemligheten fortfarande accepteras (efter en rotation). null när webhooken skapas.

Används av