Vai al contenuto principale
PATCH
Modifica un webhook. Invia solo i campi che vuoi modificare. Invia status: "enabled" per riattivare un webhook disabilitato. Vedi Avvisi di errore.
Richiede lo scope webhooks_manage.

Richiesta

Parametri di percorso

string
obbligatorio
Identificatore del webhook (UUID).

Parametri del body

string
Nuovo URL HTTPS. Stesse regole di Crea.
string[]
Nuovo elenco di tipi di evento. Sostituisce il vecchio elenco.
string[]
Nuovo elenco da 1 a 5 indirizzi. Sostituisce il vecchio elenco.
string
Nuova descrizione, al massimo 500 caratteri. null la cancella.
string
enabled o disabled. La disabilitazione annulla le consegne in attesa.

Risposta

In caso di successo, l’API restituisce 200 OK con il webhook aggiornato.
string
obbligatorio
Identificatore del webhook (UUID).
string
obbligatorio
L’URL HTTPS a cui Aniva invia gli eventi.
string
Testo libero per tuo riferimento. Può essere null.
string[]
obbligatorio
Tipi di evento che questo webhook riceve. * indica tutti i tipi.
string[]
obbligatorio
Indirizzi a cui Aniva invia un’email quando le consegne continuano a fallire.
string
obbligatorio
enabled o disabled.
string
Istante ISO 8601 UTC in cui il webhook è stato disabilitato. null mentre è abilitato.
string
Motivo per cui il webhook è stato disabilitato. Vedi Avvisi di errore. null mentre è abilitato.
string
Istante ISO 8601 UTC in cui è iniziata la serie di errori attuale. null quando l’ultima consegna è riuscita.
string
Istante ISO 8601 UTC in cui il secret precedente smette di firmare. null quando non è in corso alcuna rotazione.
string
obbligatorio
Istante ISO 8601 UTC in cui il webhook è stato creato.
string
obbligatorio
Istante ISO 8601 UTC dell’ultima modifica.

Risposte di errore