Maak een nieuw signing secret aan voor een webhook. Het oude secret blijft 24 uur ondertekenen, tot
previous_secret_expires_at. Een tweede rotatie binnen die tijd stopt het oudste secret direct.
Vereist de scope webhooks_manage.
Verzoek
Padparameters
string
vereist
Webhook-identifier (UUID).
Bodyparameters
De body is optioneel.
boolean
standaard:"false"
true stopt het huidige secret direct, bijvoorbeeld na een lek.
Respons
Bij succes geeft de API 200 OK terug met de webhook en het nieuwe 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. Zie de error-melding.
401
Ongeldige API-sleutel.
403
Geen API-sleutel, of een API-sleutel zonder de scope webhooks_manage.
404
Webhook niet gevonden, of deze hoort bij een andere API-sleutel.