Vai al contenuto principale
POST
Registra un URL HTTPS che riceve gli eventi webhook. La tua chiave API è proprietaria del webhook. Riceve un evento solo per gli oggetti che la tua chiave può leggere. Una chiave API può possedere al massimo 5 webhook.
Richiede lo scope webhooks_manage.

Richiesta

Parametri del body

string
obbligatorio
URL HTTPS sulla porta 443 con un host pubblico e senza credenziali. Aniva non segue i reindirizzamenti.
string[]
obbligatorio
Tipi di evento da ricevere, almeno uno. ["*"] indica tutti i tipi. ping non può essere incluso.
string[]
obbligatorio
Da 1 a 5 indirizzi a cui Aniva invia un’email quando le consegne continuano a fallire.
string
Testo libero per tuo riferimento, al massimo 500 caratteri.

Risposta

In caso di successo, l’API restituisce 201 Created con il webhook e il suo secret.
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