Gå til indholdet
Sursa Developers

Objekter

WebhookCreated

Felter

  • idintegerpåkrævet
  • urlstringpåkrævet
  • descriptionstringpåkrævet
  • eventsarray of WebhookEventFilterpåkrævet
  • activebooleanpåkrævet
  • statusWebhookStatuspåkrævet
  • paused_atstring (date-time) | null
  • paused_reasonstring | null

    failures: 10 mislykkede forsøg i træk; feature_disabled: prisplanen omfatter ikke webhooks.

  • disabled_reasonstring | null

    gone: modtageren svarede 410; manual: deaktiveret af en administrator.

    Tilladte værdier: gonemanualnull

  • disabled_atstring (date-time) | null
  • roleWebhookRolepåkrævet
  • data_profile_idinteger | null

    Webhookens dataprofil (null betyder ingen profil, som for en API-nøgle med samme rolle).

  • collection_idsarray of integerpåkrævet

    Samlinger, som webhooken modtager hændelser om; tom betyder alle samlinger, som rollen og dataprofilen har adgang til.

  • tagsarray of stringpåkrævet

    Hændelser for kort kun for kort med et af disse tags; tom betyder intet filter.

  • payloadWebhookPayloadModepåkrævet
  • headersarray of WebhookHeaderpåkrævet
  • auth_typestring | null

    Typen af udgående autorisation (null betyder ingen).

    Tilladte værdier: bearerbasicnull

  • auth_setbooleanpåkrævet

    Om udgående autorisation er angivet (værdierne returneres aldrig).

  • previous_secret_valid_untilstring (date-time) | null

    Indtil hvornår leveringer også signeres med den tidligere hemmelighed (null betyder, at der ikke er noget overlap).

  • healthWebhookHealth
  • consecutive_failuresintegerpåkrævet
  • 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)påkrævet
  • updated_atstring (date-time)påkrævet
  • secretstringpåkrævet

    whsec_ efterfulgt af 32 byte i base64 (nye hemmeligheder bruger standardalfabetet med udfyldning, ældre bruger base64url). Gem den hos modtageren; den vises aldrig igen i API’ets svar. Signeringsnøglen efter Standard Webhooks er base64-afkodningen af delen efter whsec_.

  • previous_valid_untilstring (date-time) | null

    Indtil hvornår den tidligere hemmelighed stadig accepteres (efter en rotation). null ved oprettelsen.

Bruges af