Discoverable catalog of webhook event types and payload fields

Programmatic catalog of webhook events. Tenant SDK consumers wiring up a receiver can consult this endpoint to know: - Which event_type strings to expect on…

GET /api/v1/system/webhook-events

cURL

curl --request GET \
  --url 'https://api.computer.stateset.app/api/v1/system/webhook-events' \
  --header "X-API-Key: $STATESET_COMPUTER_USE_API_KEY"

200

{
  "api_version": "2026-08-01",
  "envelope_fields": [
    "string"
  ],
  "events": [
    {
      "name": "Two-Person Tent",
      "description": "Two-person tent, green — replacement for damaged pole set.",
      "when_fires": "string",
      "payload_fields": []
    }
  ],
  "subscription_wildcard": "string"
}

Programmatic catalog of webhook events.

Tenant SDK consumers wiring up a receiver can consult this endpoint to know:

• Which event_type strings to expect on the wire
• Which payload fields are guaranteed (envelope + per-event)
• Which subscription wildcard means ‘everything’

The catalog is the single source of truth — both the worker (when emitting) and the subscription validators (when accepting an events array) reference it.

Cached for 300s; supports If-None-Match.

Response

WebhookEventsResponse

api_version · string · required

Schema version of the envelope (matches api_version on every delivery).

envelope_fields · string[] · required

Fields injected by the webhook envelope on every delivery.

events · WebhookEventDescriptor[] · required

Every event_type the platform may emit.

Show WebhookEventDescriptor

name · string · required

The event_type string surfaced on every webhook delivery.

description · string · required

when_fires · string · required

Human-readable trigger condition.

payload_fields · string[] · required

Top-level fields receivers can rely on (in addition to the envelope fields event_id, event_type, event_timestamp, api_version).

subscription_wildcard · string · required

When subscribing to a webhook endpoint, this token in the events array means ‘all event types’.

Status codes

Code	Meaning
200	Successful Response

cURL

curl --request GET \
  --url 'https://api.computer.stateset.app/api/v1/system/webhook-events' \
  --header "X-API-Key: $STATESET_COMPUTER_USE_API_KEY"

200

{
  "api_version": "2026-08-01",
  "envelope_fields": [
    "string"
  ],
  "events": [
    {
      "name": "Two-Person Tent",
      "description": "Two-person tent, green — replacement for damaged pole set.",
      "when_fires": "string",
      "payload_fields": []
    }
  ],
  "subscription_wildcard": "string"
}