Anar al contingut
Sursa Developers

Objectes

WebhookCreated

Camps

  • idintegerobligatori
  • urlstringobligatori
  • descriptionstringobligatori
  • eventsarray of WebhookEventFilterobligatori
  • activebooleanobligatori
  • statusWebhookStatusobligatori
  • paused_atstring (date-time) | null
  • paused_reasonstring | null

    failures: 10 intents fallits seguits; feature_disabled: el pla no inclou webhooks.

  • disabled_reasonstring | null

    gone: el receptor ha respost 410; manual: desactivat per un administrador.

    Valors permesos: gonemanualnull

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

    Perfil de dades del webhook (null vol dir sense perfil, com en una clau d’API amb el mateix rol).

  • collection_idsarray of integerobligatori

    Col·leccions sobre les quals el webhook rep esdeveniments; buit vol dir totes les col·leccions disponibles per al rol i el perfil de dades.

  • tagsarray of stringobligatori

    Esdeveniments d’entrades només per a les entrades amb alguna d’aquestes etiquetes; buit vol dir sense filtre.

  • payloadWebhookPayloadModeobligatori
  • headersarray of WebhookHeaderobligatori
  • auth_typestring | null

    Tipus d’autorització de sortida (null vol dir cap).

    Valors permesos: bearerbasicnull

  • auth_setbooleanobligatori

    Indica si l’autorització de sortida està definida (els valors no es retornen mai).

  • previous_secret_valid_untilstring (date-time) | null

    Fins quan els lliuraments també se signen amb el secret anterior (null vol dir que no hi ha solapament).

  • healthWebhookHealth
  • consecutive_failuresintegerobligatori
  • 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)obligatori
  • updated_atstring (date-time)obligatori
  • secretstringobligatori

    whsec_ seguit de 32 bytes en base64 (els secrets nous fan servir l’alfabet estàndard amb farciment, els antics fan servir base64url). Deseu-lo al costat del receptor; no torna a aparèixer mai a les respostes de l’API. La clau de signatura de Standard Webhooks és la descodificació en base64 de la part que va després de whsec_.

  • previous_valid_untilstring (date-time) | null

    Fins quan encara s’accepta el secret anterior (després d’una rotació). null en la creació.

S’usa a