Subscriptions

Eine Subscription verbindet einen Ereignistyp mit der Adresse, an die das Portal Webhook-Zustellungen sendet, siehe Webhooks. Alle Aufrufe erfordern ein Access-Token.

Anlegen

POST /api/v1/subscriptions
Content-Type: application/json

{
  "eventType": "AdmissionResponse",
  "callbackUrl": "https://zuweiser.example.org/webhooks/admission-response"
}

Antwort 201 Created:

{
  "id": "6b1f4c8a-2d93-4e17-9a05-7c3e1b8d4f62",
  "eventType": "AdmissionResponse",
  "callbackUrl": "https://zuweiser.example.org/webhooks/admission-response"
}

Existiert für den Ereignistyp bereits eine Subscription, wird deren Adresse aktualisiert und der Endpunkt antwortet mit 200 OK. Die Kennung bleibt dabei erhalten.

Abrufen

GET /api/v1/subscriptions liefert alle eigenen Subscriptions, GET /api/v1/subscriptions/{id} eine einzelne. Eine unbekannte oder fremde Kennung ergibt 404 Not Found.

Ändern

PUT /api/v1/subscriptions/{id} ändert die Adresse:

{ "callbackUrl": "https://zuweiser.example.org/webhooks/neu" }

Löschen

DELETE /api/v1/subscriptions/{id} entfernt die Subscription und verwirft ihre noch nicht zugestellten Ereignisse.