Zum Hauptinhalt springen
POST
Erstelle ein neues Signing-Secret für einen Webhook. Das alte Secret signiert noch 24 Stunden weiter, bis previous_secret_expires_at. Eine zweite Rotation innerhalb dieser Zeit beendet das älteste Secret sofort.
Erfordert den Scope webhooks_manage.

Anfrage

Pfadparameter

string
erforderlich
Webhook-Kennung (UUID).

Body-Parameter

Der Body ist optional.
boolean
Standard:"false"
true beendet das aktuelle Secret sofort, zum Beispiel nach einem Leak.

Antwort

Bei Erfolg gibt die API 200 OK mit dem Webhook und seinem neuen Secret zurück.
string
erforderlich
Das Signatur-Secret, whsec_ plus Base64. Aniva zeigt es nur in dieser Antwort an. Siehe Signatur prüfen.
string
erforderlich
Webhook-Kennung (UUID).
string
erforderlich
Die HTTPS-URL, an die Aniva Events sendet.
string
Freitext für deine eigene Referenz. Kann null sein.
string[]
erforderlich
Event-Typen, die dieser Webhook empfängt. * steht für alle Typen.
string[]
erforderlich
Adressen, an die Aniva eine E-Mail sendet, wenn Zustellungen wiederholt fehlschlagen.
string
erforderlich
enabled oder disabled.
string
ISO-8601-UTC-Zeitpunkt, zu dem der Webhook deaktiviert wurde. null, solange er aktiviert ist.
string
Warum der Webhook deaktiviert wurde. Siehe Fehlerbenachrichtigungen. null, solange er aktiviert ist.
string
ISO-8601-UTC-Zeitpunkt, zu dem die aktuelle Serie von Fehlschlägen begonnen hat. null, wenn die letzte Zustellung erfolgreich war.
string
ISO-8601-UTC-Zeitpunkt, zu dem das vorherige Secret nicht mehr zum Signieren verwendet wird. null, wenn keine Rotation läuft.
string
erforderlich
ISO-8601-UTC-Zeitpunkt, zu dem der Webhook erstellt wurde.
string
erforderlich
ISO-8601-UTC-Zeitpunkt der letzten Änderung.

Fehlerantworten