Salt la conținutul principal
POST
Înregistrează un URL HTTPS care primește evenimente webhook. Cheia ta API deține webhook-ul. Acesta primește un eveniment doar pentru obiectele pe care cheia ta le poate citi. O cheie API poate deține cel mult 5 webhook-uri.
Necesită scope-ul webhooks_manage.

Cerere

Parametri de corp

string
obligatoriu
URL HTTPS pe portul 443, cu un host public și fără credențiale. Aniva nu urmărește redirecționările.
string[]
obligatoriu
Tipuri de evenimente de primit, cel puțin unul. ["*"] înseamnă toate tipurile. ping nu poate fi inclus în listă.
string[]
obligatoriu
Între 1 și 5 adrese la care Aniva trimite e-mailuri când livrările continuă să eșueze.
string
Text liber pentru referința ta, de cel mult 500 de caractere.

Răspuns

La succes, API-ul returnează 201 Created cu webhook-ul și secretul său.
string
obligatoriu
Secretul de semnare, whsec_ plus base64. Aniva îl afișează doar în acest răspuns. Vezi Verifică semnătura.
string
obligatoriu
Identificatorul webhook-ului (UUID).
string
obligatoriu
URL-ul HTTPS la care Aniva trimite evenimente.
string
Text liber pentru referința ta. Poate fi null.
string[]
obligatoriu
Tipurile de evenimente pe care le primește acest webhook. * înseamnă toate tipurile.
string[]
obligatoriu
Adresele la care Aniva trimite e-mailuri când livrările continuă să eșueze.
string
obligatoriu
enabled sau disabled.
string
Momentul ISO 8601 UTC în care webhook-ul a fost dezactivat. null cât timp este activ.
string
Motivul pentru care webhook-ul a fost dezactivat. Vezi Notificări de eșec. null cât timp este activ.
string
Momentul ISO 8601 UTC în care a început seria curentă de eșecuri. null când ultima livrare a reușit.
string
Momentul ISO 8601 UTC în care secretul anterior nu mai este folosit la semnare. null când nu este în curs nicio rotație.
string
obligatoriu
Momentul ISO 8601 UTC în care webhook-ul a fost creat.
string
obligatoriu
Momentul ISO 8601 UTC al ultimei modificări.

Răspunsuri de eroare