Zum Hauptinhalt springen
POST
Registriere eine HTTPS-URL, die Webhook-Events empfängt. Dein API-Schlüssel besitzt den Webhook. Er empfängt ein Event nur für Objekte, die dein Schlüssel lesen kann. Ein API-Schlüssel kann höchstens 5 Webhooks besitzen.
Erfordert den Scope webhooks_manage.

Anfrage

Body-Parameter

string
erforderlich
HTTPS-URL auf Port 443 mit öffentlichem Host und ohne Zugangsdaten. Aniva folgt keinen Weiterleitungen.
string[]
erforderlich
Event-Typen, die empfangen werden sollen, mindestens einer. ["*"] steht für alle Typen. ping kann nicht angegeben werden.
string[]
erforderlich
1 bis 5 Adressen, an die Aniva eine E-Mail sendet, wenn Zustellungen wiederholt fehlschlagen.
string
Freitext für deine eigene Referenz, höchstens 500 Zeichen.

Antwort

Bei Erfolg gibt die API 201 Created mit dem Webhook und seinem 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