Vai al contenuto
Sursa Developers

Oggetti

WebhookCreated

Campi

  • idintegerobbligatorio
  • urlstringobbligatorio
  • descriptionstringobbligatorio
  • eventsarray of WebhookEventFilterobbligatorio
  • activebooleanobbligatorio
  • statusWebhookStatusobbligatorio
  • paused_atstring (date-time) | null
  • paused_reasonstring | null

    failures: 10 tentativi non riusciti di seguito; feature_disabled: il piano non include i webhook.

  • disabled_reasonstring | null

    gone: il ricevitore ha risposto 410; manual: disattivato da un amministratore.

    Valori ammessi: gonemanualnull

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

    Profilo dati del webhook (null indica nessun profilo, come per una chiave API con lo stesso ruolo).

  • collection_idsarray of integerobbligatorio

    Raccolte sui cui eventi il webhook riceve notifiche; vuoto indica tutte le raccolte disponibili per il ruolo e il profilo dati.

  • tagsarray of stringobbligatorio

    Eventi delle schede solo per le schede con almeno uno di questi tag; vuoto indica nessun filtro.

  • payloadWebhookPayloadModeobbligatorio
  • headersarray of WebhookHeaderobbligatorio
  • auth_typestring | null

    Tipo di autorizzazione in uscita (null indica nessuna).

    Valori ammessi: bearerbasicnull

  • auth_setbooleanobbligatorio

    Indica se è impostata un’autorizzazione in uscita (i valori non vengono mai restituiti).

  • previous_secret_valid_untilstring (date-time) | null

    Fino a quando le consegne vengono firmate anche con il segreto precedente (null indica che non c’è sovrapposizione).

  • healthWebhookHealth
  • consecutive_failuresintegerobbligatorio
  • 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)obbligatorio
  • updated_atstring (date-time)obbligatorio
  • secretstringobbligatorio

    whsec_ seguito da 32 byte in base64 (i nuovi segreti usano l’alfabeto standard con padding, quelli meno recenti usano base64url). Conservalo sul lato del ricevitore; non compare mai più nelle risposte dell’API. La chiave di firma di Standard Webhooks è la decodifica base64 della parte dopo whsec_.

  • previous_valid_untilstring (date-time) | null

    Fino a quando il segreto precedente viene ancora accettato (dopo una rotazione). null alla creazione.

Usato da