Zum Hauptinhalt springen
PATCH
Ändere einen Webhook. Sende nur die Felder, die du ändern möchtest. Sende status: "enabled", um einen deaktivierten Webhook wieder zu starten. Siehe Fehlerbenachrichtigungen.
Erfordert den Scope webhooks_manage.

Anfrage

Pfadparameter

string
erforderlich
Webhook-Kennung (UUID).

Body-Parameter

string
Neue HTTPS-URL. Dieselben Regeln wie bei Erstellen.
string[]
Neue Liste von Event-Typen. Ersetzt die alte Liste.
string[]
Neue Liste mit 1 bis 5 Adressen. Ersetzt die alte Liste.
string
Neue Beschreibung, höchstens 500 Zeichen. null löscht sie.
string
enabled oder disabled. Das Deaktivieren bricht die ausstehenden Zustellungen ab.

Antwort

Bei Erfolg gibt die API 200 OK mit dem aktualisierten Webhook zurück.
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