Spring til hovedindhold
POST
Registrer en HTTPS-URL, der modtager webhookhændelser. Din API-nøgle ejer webhooken. Den modtager kun en hændelse for objekter, som din nøgle kan læse. En API-nøgle kan højst eje 5 webhooks.
Kræver scopet webhooks_manage.

Forespørgsel

Body-parametre

string
påkrævet
HTTPS-URL på port 443 med en offentlig vært og uden loginoplysninger. Aniva følger ikke omdirigeringer.
string[]
påkrævet
Hændelsestyper, der skal modtages, mindst én. ["*"] betyder alle typer. ping kan ikke angives.
string[]
påkrævet
1 til 5 adresser, som Aniva sender e-mail til, når leveringer bliver ved med at fejle.
string
Fritekst til din egen reference, højst 500 tegn.

Svar

Ved succes returnerer API’et 201 Created med webhooken og dens hemmelighed.
string
påkrævet
Signeringshemmeligheden, whsec_ plus base64. Aniva viser den kun i dette svar. Se Bekræft signaturen.
string
påkrævet
Webhookidentifikator (UUID).
string
påkrævet
Den HTTPS-URL, som Aniva sender hændelser til.
string
Fritekst til din egen reference. Kan være null.
string[]
påkrævet
Hændelsestyper, som denne webhook modtager. * betyder alle typer.
string[]
påkrævet
Adresser, som Aniva sender e-mail til, når leveringer bliver ved med at fejle.
string
påkrævet
enabled eller disabled.
string
ISO 8601 UTC-tidspunkt for, hvornår webhooken blev deaktiveret. null, mens den er aktiveret.
string
Hvorfor webhooken blev deaktiveret. Se Fejlmeddelelser. null, mens den er aktiveret.
string
ISO 8601 UTC-tidspunkt for, hvornår den aktuelle række af fejl startede. null, når den seneste levering lykkedes.
string
ISO 8601 UTC-tidspunkt for, hvornår den forrige hemmelighed stopper med at signere. null, når ingen rotation er i gang.
string
påkrævet
ISO 8601 UTC-tidspunkt for, hvornår webhooken blev oprettet.
string
påkrævet
ISO 8601 UTC-tidspunkt for seneste ændring.

Fejlsvar