Skip to main content
PUT
Webhook-Endpunkt ändern

Authorizations

Authorization
string
header
required

Access-Token aus POST /auth/login (E-Mail und Passwort), gesendet als Authorization: Bearer <token>.

Das Token ist zeitlich begrenzt gültig. Mit dem refresh_token aus derselben Antwort holt POST /auth/token/refresh ein neues Token-Paar, ohne das Passwort erneut zu senden; POST /auth/token/invalidate macht den Refresh-Token beim Abmelden ungültig.

Ist für das Konto ein zweiter Faktor aktiv oder vorgeschrieben, liefert der Login statt des Token-Paars mfaRequired: true bzw. mfaEnrollmentRequired: true und ein kurzlebiges preAuthToken. Mit diesem Token (ebenfalls als Bearer) wird der zweite Faktor über POST /auth/2fa/verify bestätigt; erst danach gibt es das volle Token-Paar.

Headers

X-Customer-Id
string

Optionaler Kundenkontext. Ohne Header arbeitet die Anfrage im Standard-Kunden des angemeldeten Benutzers. Mit der ID eines anderen Kunden handelt die Anfrage in dessen Kontext: Listen, Lese- und Schreibzugriffe beziehen sich dann auf diesen Kunden.

Erlaubt sind der eigene Kunde, jeder Unterkunde im eigenen Teilbaum (Reseller handelt für seinen Endkunden) sowie Kunden, in denen der Benutzer selbst Mitglied ist. Übergeordnete oder fremde Kunden werden mit 403 Forbidden abgewiesen, eine unbekannte ID ebenfalls.

Die IDs der erreichbaren Kunden liefern GET /user/customers und GET /customers/{id}/children.

Example:

"01JD4Q8W3N6Y2K5T7R9V0B1C2D"

Path Parameters

id
string
required

WebhookEndpoint identifier

Body

application/json

The updated WebhookEndpoint resource

Ziel für ausgehende Ereignis-Webhooks eines Kunden (ARC-216).

url
string
default:""
required
Maximum string length: 2048
Example:

"https://hooks.example.com/netz"

description
string | null
Maximum string length: 255
Example:

"ERP-Anbindung"

eventTypes
string[]
Minimum array length: 1
Example:
enabled
boolean
default:true

Response

WebhookEndpoint resource updated

Ziel für ausgehende Ereignis-Webhooks eines Kunden (ARC-216).

id
string
read-only
Example:

"01JD5M2Q8Y4X3W7V6T5S4R3Q2P"

url
string
Example:

"https://hooks.example.com/netz"

description
string | null
Example:

"ERP-Anbindung"

eventTypes
string[]
Example:
enabled
boolean
default:true
read-only
disabledReason
string | null
read-only

Grund der Deaktivierung: customer (von Hand) oder failures (automatisch).

disabledAt
string<date-time> | null
read-only
previousSigningKeyExpiresAt
string<date-time> | null
read-only
signingKeyRotatedAt
string<date-time> | null
read-only
failingSince
string<date-time> | null
read-only

Beginn der laufenden Fehlerserie (erster Fehlschlag seit dem letzten Erfolg).

consecutiveFailures
integer
default:0
read-only
lastSuccessAt
string<date-time> | null
read-only
lastFailureAt
string<date-time> | null
read-only
createdAt
string<date-time>
updatedAt
string<date-time>
customerId
string
read-only