Hoppa till huvudinnehåll
POST
Registrera en HTTPS-URL som tar emot webhook-händelser. Din API-nyckel äger webhooken. Den tar bara emot händelser för objekt som din nyckel kan läsa. En API-nyckel kan äga högst 5 webhooks.
Kräver scopet webhooks_manage.

Förfrågan

Body-parametrar

string
obligatorisk
HTTPS-URL på port 443 med en publik värd och utan inloggningsuppgifter. Aniva följer inte omdirigeringar.
string[]
obligatorisk
Händelsetyper att ta emot, minst en. ["*"] innebär alla typer. ping kan inte listas.
string[]
obligatorisk
1 till 5 adresser som Aniva mejlar när leveranser fortsätter att misslyckas.
string
Fritext för din egen referens, högst 500 tecken.

Svar

Vid lyckat anrop returnerar API:et 201 Created med webhooken och dess hemlighet.
string
obligatorisk
Signeringshemligheten, whsec_ plus base64. Aniva visar den bara i det här svaret. Se Verifiera signaturen.
string
obligatorisk
Webhook-identifierare (UUID).
string
obligatorisk
Den HTTPS-URL som Aniva skickar händelser till.
string
Fritext för din egen referens. Kan vara null.
string[]
obligatorisk
Händelsetyper som den här webhooken tar emot. * innebär alla typer.
string[]
obligatorisk
Adresser som Aniva mejlar när leveranser fortsätter att misslyckas.
string
obligatorisk
enabled eller disabled.
string
Tidpunkt i ISO 8601 UTC då webhooken inaktiverades. null medan den är aktiverad.
string
Varför webhooken inaktiverades. Se Felaviseringar. null medan den är aktiverad.
string
Tidpunkt i ISO 8601 UTC då den aktuella sviten av misslyckanden började. null när den senaste leveransen lyckades.
string
Tidpunkt i ISO 8601 UTC då den föregående hemligheten slutar signera. null när ingen rotation pågår.
string
obligatorisk
Tidpunkt i ISO 8601 UTC då webhooken skapades.
string
obligatorisk
Tidpunkt i ISO 8601 UTC för den senaste ändringen.

Felsvar