API

Webhooks

API reference for Webhooks: every handler with its fields and an example.

Last updated:

webhook-subscriber: detail

Get webhook

Returns a single webhook subscriber row by id, including its URL, event filter, and delivery-failure tracking, for the webhook edit screen. The signing secret is never returned.

  • Required scope: webhooks:read
  • Endpoint: POST /api/query
Field Type Required Description
id string (uuid) yes

Example request

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

List webhooks

Returns a filtered, paginated set of webhook subscriber rows with their URL, event filter, active state, and delivery-failure tracking, for the admin webhook list. The signing secret is never returned.

  • Required scope: webhooks:read
  • Endpoint: POST /api/query
Field Type Required Description
cursor string no Position from nextCursor of the previous page.
limit integer no Rows per page, 50 by default, at most 200.
search string no Full-text search across the searchable fields.
sort string no Field to sort by.
sortDirection “asc” | “desc” no asc or desc.
offset integer no Number of rows to skip. Prefer cursor for paging.
totalCount boolean no Set true to also get total, the number of matching rows.
includeDeleted boolean no Set true to include deleted rows. Only for entities with soft delete.
onlyDeleted boolean no Set true to return only deleted rows. Only for entities with soft delete, not together with includeDeleted.
filter object no One field filter with field, op and value. op is one of eq, ne, lt, gt, lte, gte, in.
filter.field string yes
filter.op “eq” | “ne” | “lt” | “gt” | “lte” | “gte” | “in” yes
filter.value any yes
filters array of object no Several field filters, each with field, op and value. op is one of eq, ne, lt, gt, lte, gte, in.
namedFilter string no Name of a predefined filter of the entity, for example a work queue.
aggregate object no Returns aggregated values instead of rows.
aggregate.groupBy string no
aggregate.measures array of object no

Example request

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": {}
}'

Example response

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

Create webhook

Registers an HTTPS endpoint that receives signed webhook events and returns its signing secret once.

  • Required scope: webhooks:write
  • Endpoint: POST /api/write
Field Type Required Description
url string (uri) yes URL
description string no Name
events array of “incident.created” | “incident.updated” | “incident.resolved” | “component.updated” | “maintenance.scheduled” | “maintenance.started” | “maintenance.completed” | “maintenance.cancelled” no Events

Example request

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"
    ]
  }
}'

Example response

Status: 200

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

webhook-subscriber: delete

Delete webhook

Permanently deletes a webhook, so its endpoint receives no further events.

  • Required scope: webhooks:write
  • Endpoint: POST /api/write
Field Type Required Description
id string (uuid) yes

Example request

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

Reactivate webhook

Switches a deactivated webhook on again and resets its failure count.

  • Required scope: webhooks:write
  • Endpoint: POST /api/write
Field Type Required Description
id string (uuid) yes

Example request

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

Rotate webhook secret

Replaces the signing secret of a webhook and returns the new secret once; the old secret stops working immediately.

  • Required scope: webhooks:write
  • Endpoint: POST /api/write
Field Type Required Description
id string (uuid) yes
version number no

Example request

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

Update webhook

Changes the URL, description or event selection of a webhook.

  • Required scope: webhooks:write
  • Endpoint: POST /api/write
Field Type Required Description
id string (uuid) yes
version number yes
changes object yes
changes.url string (uri) no URL
changes.description string | null no Name
changes.events array of “incident.created” | “incident.updated” | “incident.resolved” | “component.updated” | “maintenance.scheduled” | “maintenance.started” | “maintenance.completed” | “maintenance.cancelled” no Events

Example request

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"
      ]
    }
  }
}'