Hopp til hovedinnhold
POST
Registrer en HTTPS-URL som mottar webhook-hendelser. API-nøkkelen din eier webhooken. Den mottar bare hendelser for objekter nøkkelen din kan lese. En API-nøkkel kan eie maks 5 webhooks.
Krever scopet webhooks_manage.

Forespørsel

Body-parametere

string
påkrevd
HTTPS-URL på port 443 med en offentlig vert og uten påloggingsinformasjon. Aniva følger ikke omdirigeringer.
string[]
påkrevd
Hendelsestyper som skal mottas, minst én. ["*"] betyr alle typer. ping kan ikke tas med.
string[]
påkrevd
1 til 5 adresser Aniva sender e-post til når leveringer fortsetter å feile.
string
Fritekst til egen referanse, maks 500 tegn.

Respons

Når forespørselen lykkes, returnerer API-et 201 Created med webhooken og hemmeligheten dens.
string
påkrevd
Signeringshemmeligheten, whsec_ pluss base64. Aniva viser den bare i dette svaret. Se Verifiser signaturen.
string
påkrevd
Webhook-identifikator (UUID).
string
påkrevd
HTTPS-URL-en Aniva sender hendelser til.
string
Fritekst til egen referanse. Kan være null.
string[]
påkrevd
Hendelsestyper denne webhooken mottar. * betyr alle typer.
string[]
påkrevd
Adresser Aniva sender e-post til når leveringer fortsetter å feile.
string
påkrevd
enabled eller disabled.
string
ISO 8601 UTC-tidspunkt da webhooken ble deaktivert. null mens den er aktivert.
string
Hvorfor webhooken ble deaktivert. Se Feilvarsler. null mens den er aktivert.
string
ISO 8601 UTC-tidspunkt da den pågående feilrekken startet. null når siste levering lyktes.
string
ISO 8601 UTC-tidspunkt da den forrige hemmeligheten slutter å signere. null når ingen rotasjon pågår.
string
påkrevd
ISO 8601 UTC-tidspunkt da webhooken ble opprettet.
string
påkrevd
ISO 8601 UTC-tidspunkt for siste endring.

Feilresponser