Oggetti
WebhookEndpoint
Campi
idintegerobbligatoriourlstringobbligatoriodescriptionstringobbligatorioactivebooleanobbligatoriopaused_atstring (date-time) | nullpaused_reasonstring | nullfailures: 10 tentativi non riusciti di seguito;feature_disabled: il piano non include i webhook.disabled_reasonstring | nullgone: il ricevitore ha risposto 410;manual: disattivato da un amministratore.Valori ammessi:
gonemanualnulldisabled_atstring (date-time) | nulldata_profile_idinteger | nullProfilo dati del webhook (
nullindica nessun profilo, come per una chiave API con lo stesso ruolo).collection_idsarray of integerobbligatorioRaccolte sui cui eventi il webhook riceve notifiche; vuoto indica tutte le raccolte disponibili per il ruolo e il profilo dati.
tagsarray of stringobbligatorioEventi delle schede solo per le schede con almeno uno di questi tag; vuoto indica nessun filtro.
auth_typestring | nullTipo di autorizzazione in uscita (
nullindica nessuna).Valori ammessi:
bearerbasicnullauth_setbooleanobbligatorioIndica se è impostata un’autorizzazione in uscita (i valori non vengono mai restituiti).
previous_secret_valid_untilstring (date-time) | nullFino a quando le consegne vengono firmate anche con il segreto precedente (
nullindica che non c’è sovrapposizione).healthWebhookHealthconsecutive_failuresintegerobbligatoriolast_delivery_atstring (date-time) | nulllast_success_atstring (date-time) | nulllast_errorstring | nullcreated_byinteger | nullcreated_by_namestring | nullcreated_atstring (date-time)obbligatorioupdated_atstring (date-time)obbligatorio
Usato da
- GET
/v1/webhooks/{webhook_id}Ottenere un webhook - PATCH
/v1/webhooks/{webhook_id}Aggiornare un webhook - POST
/v1/webhooks/{webhook_id}/revoke-previous-secretRevocare il segreto precedente - POST
/v1/webhooks/{webhook_id}/resumeRiprendere un webhook