Vai al contenuto principale
POST
Crea un nuovo segreto di firma per un webhook. Il vecchio segreto continua a firmare per 24 ore, fino a previous_secret_expires_at. Una seconda rotazione entro questo intervallo disattiva subito il segreto più vecchio.
Richiede lo scope webhooks_manage.

Richiesta

Parametri di percorso

string
obbligatorio
Identificatore del webhook (UUID).

Parametri del body

Il corpo è facoltativo.
boolean
predefinito:"false"
true disattiva subito il segreto attuale, ad esempio dopo una fuga di dati.

Risposta

In caso di successo, l’API restituisce 200 OK con il webhook e il suo nuovo segreto.
string
obbligatorio
Il secret di firma, whsec_ più base64. Aniva lo mostra solo in questa risposta. Vedi Verifica la firma.
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