curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.sandbox.stateset.app/api/v1/webhooks' \
--header "Authorization: ApiKey $STATESET_SANDBOX_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"url": "https://example.com/webhooks/stateset",
"events": [
"string"
],
"secret": "REPLACE_WITH_A_RANDOM_SECRET_"
}'
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"url": "https://example.com/webhooks/stateset",
"events": "*",
"hasSecret": true,
"enabled": true,
"orgId": "string",
"sandboxId": "string",
"headers": {},
"retryCount": 1,
"retryDelayMs": 1,
"timeoutMs": 250,
"createdAt": "2026-08-31T14:22:05Z"
}
Register a webhook endpoint
Webhook registered. Keys are camelCase, matching the controller’s WebhookConfig; the secret is stripped.
POST
/
api
/
v1
/
webhooks
curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.sandbox.stateset.app/api/v1/webhooks' \
--header "Authorization: ApiKey $STATESET_SANDBOX_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"url": "https://example.com/webhooks/stateset",
"events": [
"string"
],
"secret": "REPLACE_WITH_A_RANDOM_SECRET_"
}'
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"url": "https://example.com/webhooks/stateset",
"events": "*",
"hasSecret": true,
"enabled": true,
"orgId": "string",
"sandboxId": "string",
"headers": {},
"retryCount": 1,
"retryDelayMs": 1,
"timeoutMs": 250,
"createdAt": "2026-08-31T14:22:05Z"
}
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.
Request body
CreateWebhookRequest
string (uri)
required
string[]
required
Minimum items:
1.string
Minimum length:
16. Maximum length: 256.Response
object
string
required
string
required
string | string[]
required
Either the literal ’*’ or an array of subscribed event names. Allowed values:
'*'.Show events
Show events
Show Option 1: string
Show Option 1: string
Allowed values:
'*'.Show Option 2: string[]
Show Option 2: string[]
Value of type
string[].boolean
boolean
required
string
string
object
Additional keys map to values of type
string.integer
required
integer
required
integer
required
string (date-time)
required
Status codes
| Code | Meaning |
|---|---|
201 | Webhook registered. Keys are camelCase, matching the controller’s WebhookConfig; the secret is stripped. |
400 | Invalid request |
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 POST \
--url 'https://api.sandbox.stateset.app/api/v1/webhooks' \
--header "Authorization: ApiKey $STATESET_SANDBOX_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"url": "https://example.com/webhooks/stateset",
"events": [
"string"
],
"secret": "REPLACE_WITH_A_RANDOM_SECRET_"
}'
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"url": "https://example.com/webhooks/stateset",
"events": "*",
"hasSecret": true,
"enabled": true,
"orgId": "string",
"sandboxId": "string",
"headers": {},
"retryCount": 1,
"retryDelayMs": 1,
"timeoutMs": 250,
"createdAt": "2026-08-31T14:22:05Z"
}
Last modified on September 21, 2026