curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.computer.stateset.app/api/v1/system/webhook-events' \
--header "X-API-Key: $STATESET_COMPUTER_USE_API_KEY"
{
"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": [
"string"
]
}
],
"subscription_wildcard": "string"
}
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 --silent --show-error --fail-with-body --request GET \
--url 'https://api.computer.stateset.app/api/v1/system/webhook-events' \
--header "X-API-Key: $STATESET_COMPUTER_USE_API_KEY"
{
"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": [
"string"
]
}
],
"subscription_wildcard": "string"
}
Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
- Which
event_typestrings to expect on the wire - Which payload fields are guaranteed (envelope + per-event)
- Which subscription wildcard means ‘everything’
events array) reference it.
Cached for 300s; supports If-None-Match.
Response
WebhookEventsResponse
string
required
Schema version of the envelope (matches
api_version on every delivery).string[]
required
Fields injected by the webhook envelope on every delivery.
WebhookEventDescriptor[]
required
Every event_type the platform may emit.
Show WebhookEventDescriptor
Show WebhookEventDescriptor
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 |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.computer.stateset.app/api/v1/system/webhook-events' \
--header "X-API-Key: $STATESET_COMPUTER_USE_API_KEY"
{
"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": [
"string"
]
}
],
"subscription_wildcard": "string"
}
Last modified on September 21, 2026