API

Webhooks

API-Referenz für Webhooks: jeder Handler mit seinen Feldern und einem Beispiel.

Stand:

webhook-subscriber: detail

Webhook abrufen

Liefert einen einzelnen Webhook per ID mit URL, Ereignisauswahl und Zustellfehlern. Das Signatur-Secret wird nie zurückgegeben.

  • Benötigter Scope: webhooks:read
  • Endpunkt: POST /api/query
Feld Typ Pflicht Beschreibung
id string (uuid) ja

Beispielanfrage

curl -X POST https://status.example.com/api/query \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "publicstatus:query:webhook-subscriber:detail",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001"
  }
}'

webhook-subscriber: list

Webhooks auflisten

Liefert eine gefilterte, seitenweise Liste der Webhooks mit URL, Ereignisauswahl, Aktivstatus und Zustellfehlern. Das Signatur-Secret wird nie zurückgegeben.

  • Benötigter Scope: webhooks:read
  • Endpunkt: POST /api/query
Feld Typ Pflicht Beschreibung
cursor string nein Position aus nextCursor der vorherigen Seite.
limit integer nein Zeilen pro Seite, standardmäßig 50, höchstens 200.
search string nein Volltextsuche über die durchsuchbaren Felder.
sort string nein Feld, nach dem sortiert wird.
sortDirection “asc” | “desc” nein asc oder desc.
offset integer nein Anzahl der zu überspringenden Zeilen. Nutze besser cursor zum Blättern.
totalCount boolean nein Mit true bekommst du zusätzlich total, die Anzahl der passenden Zeilen.
includeDeleted boolean nein Mit true sind gelöschte Zeilen enthalten. Nur für Entitäten mit Soft Delete.
onlyDeleted boolean nein Mit true kommen nur gelöschte Zeilen zurück. Nur für Entitäten mit Soft Delete, nicht zusammen mit includeDeleted.
filter object nein Ein Feldfilter mit field, op und value. op ist einer von eq, ne, lt, gt, lte, gte, in.
filter.field string ja
filter.op “eq” | “ne” | “lt” | “gt” | “lte” | “gte” | “in” ja
filter.value any ja
filters array of object nein Mehrere Feldfilter, je mit field, op und value. op ist einer von eq, ne, lt, gt, lte, gte, in.
namedFilter string nein Name eines vordefinierten Filters der Entität, zum Beispiel einer Arbeitsliste.
aggregate object nein Liefert aggregierte Werte statt Zeilen.
aggregate.groupBy string nein
aggregate.measures array of object nein

Beispielanfrage

curl -X POST https://status.example.com/api/query \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "publicstatus:query:webhook-subscriber:list",
  "payload": {}
}'

Beispielantwort

Status: 200

{
  "data": {
    "nextCursor": null,
    "rows": [
      {
        "id": "00000000-0000-4000-8000-000000000001",
        "tenantId": "00000000-0000-4000-8000-000000000002",
        "version": 1,
        "insertedAt": "2026-01-15T09:30:00.000Z",
        "modifiedAt": null,
        "insertedById": "00000000-0000-4000-8000-000000000003",
        "modifiedById": null,
        "url": "https://93.184.216.34/hook",
        "description": null,
        "events": [
          "incident.created"
        ],
        "active": true,
        "failureCount": 0,
        "lastDeliveryAt": null,
        "lastFailureAt": null,
        "lastFailureReason": null
      }
    ]
  }
}

webhook-subscriber: create

Webhook anlegen

Registriert eine HTTPS-Adresse, die signierte Webhook-Ereignisse erhält, und gibt ihr Signatur-Secret einmal zurück.

  • Benötigter Scope: webhooks:write
  • Endpunkt: POST /api/write
Feld Typ Pflicht Beschreibung
url string (uri) ja URL
description string nein Name
events array of “incident.created” | “incident.updated” | “incident.resolved” | “component.updated” | “maintenance.scheduled” | “maintenance.started” | “maintenance.completed” | “maintenance.cancelled” nein Ereignisse

Beispielanfrage

curl -X POST https://status.example.com/api/write \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "publicstatus:write:webhook-subscriber:create",
  "payload": {
    "url": "https://93.184.216.34/hook",
    "events": [
      "incident.created"
    ]
  }
}'

Beispielantwort

Status: 200

{
  "isSuccess": true,
  "data": {
    "id": "00000000-0000-4000-8000-000000000001",
    "secret": "REDACTED"
  }
}

webhook-subscriber: delete

Webhook löschen

Löscht einen Webhook endgültig, sodass seine Adresse keine Ereignisse mehr erhält.

  • Benötigter Scope: webhooks:write
  • Endpunkt: POST /api/write
Feld Typ Pflicht Beschreibung
id string (uuid) ja

Beispielanfrage

curl -X POST https://status.example.com/api/write \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "publicstatus:write:webhook-subscriber:delete",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001"
  }
}'

webhook-subscriber: reactivate

Webhook wieder aktivieren

Schaltet einen deaktivierten Webhook wieder ein und setzt seinen Fehlerzähler zurück.

  • Benötigter Scope: webhooks:write
  • Endpunkt: POST /api/write
Feld Typ Pflicht Beschreibung
id string (uuid) ja

Beispielanfrage

curl -X POST https://status.example.com/api/write \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "publicstatus:write:webhook-subscriber:reactivate",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001"
  }
}'

webhook-subscriber: rotate-secret

Webhook-Secret erneuern

Ersetzt das Signatur-Secret eines Webhooks und gibt das neue Secret einmal zurück. Das alte Secret gilt sofort nicht mehr.

  • Benötigter Scope: webhooks:write
  • Endpunkt: POST /api/write
Feld Typ Pflicht Beschreibung
id string (uuid) ja
version number nein

Beispielanfrage

curl -X POST https://status.example.com/api/write \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "publicstatus:write:webhook-subscriber:rotate-secret",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001",
    "version": 1
  }
}'

webhook-subscriber: update

Webhook ändern

Ändert URL, Beschreibung oder Ereignisauswahl eines Webhooks.

  • Benötigter Scope: webhooks:write
  • Endpunkt: POST /api/write
Feld Typ Pflicht Beschreibung
id string (uuid) ja
version number ja
changes object ja
changes.url string (uri) nein URL
changes.description string | null nein Name
changes.events array of “incident.created” | “incident.updated” | “incident.resolved” | “component.updated” | “maintenance.scheduled” | “maintenance.started” | “maintenance.completed” | “maintenance.cancelled” nein Ereignisse

Beispielanfrage

curl -X POST https://status.example.com/api/write \
  -H "Authorization: Bearer $API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "publicstatus:write:webhook-subscriber:update",
  "payload": {
    "id": "00000000-0000-4000-8000-000000000001",
    "version": 1,
    "changes": {
      "url": "https://example.com",
      "description": "text",
      "events": [
        "incident.created"
      ]
    }
  }
}'