{ "error": "An API key can own at most 5 webhooks"}
Registreer een HTTPS-URL die webhook-events ontvangt. Je API-sleutel is de eigenaar van de
webhook. Deze ontvangt alleen een event voor objecten die je sleutel kan lezen. Een API-sleutel kan maximaal 5
webhooks bezitten.
Vereist de scope webhooks_manage.
Verzoek
Bodyparameters
string
vereist
HTTPS-URL op poort 443 met een publieke host en zonder inloggegevens. Aniva volgt geen redirects.
string[]
vereist
Eventtypen om te ontvangen, minimaal één. ["*"] betekent elk type.
ping kan niet worden opgenomen.
string[]
vereist
1 tot 5 adressen waarnaar Aniva een e-mail stuurt wanneer afleveringen blijven mislukken.
string
Vrije tekst voor eigen referentie, maximaal 500 tekens.
Respons
Bij succes geeft de API 201 Created terug met de webhook en het secret.
string
vereist
Het signing secret, whsec_ plus base64. Aniva toont dit alleen in deze response. Zie De
handtekening verifiëren.
string
vereist
Webhook-identifier (UUID).
string
vereist
De HTTPS-URL waarnaar Aniva events verstuurt.
string
Vrije tekst voor eigen referentie. Kan null zijn.
string[]
vereist
Eventtypen die deze webhook ontvangt. * betekent elk type.
string[]
vereist
Adressen waarnaar Aniva een e-mail stuurt wanneer afleveringen blijven mislukken.
string
vereist
enabled of disabled.
string
ISO 8601 UTC-tijdstip waarop de webhook is uitgeschakeld. null zolang deze is ingeschakeld.
string
Waarom de webhook is uitgeschakeld. Zie Foutmeldingen. null
zolang deze is ingeschakeld.
string
ISO 8601 UTC-tijdstip waarop de huidige reeks mislukkingen begon. null wanneer de laatste aflevering is geslaagd.
string
ISO 8601 UTC-tijdstip waarop het vorige secret niet meer wordt gebruikt om te ondertekenen. null wanneer er geen rotatie bezig is.
string
vereist
ISO 8601 UTC-tijdstip waarop de webhook is aangemaakt.
string
vereist
ISO 8601 UTC-tijdstip van de laatste wijziging.
Foutresponsen
Status
Beschrijving
400
Ongeldig verzoek, bijvoorbeeld een onjuiste URL, een onbekend eventtype, ongeldige alert_emails of een API-sleutel die geen webhook kan bezitten.
401
Ongeldige API-sleutel.
403
Geen API-sleutel, of een API-sleutel zonder de scope webhooks_manage.