curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.computer.stateset.app/api/v1/webhook-test' \
--header "X-API-Key: $STATESET_COMPUTER_USE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"url": "https://example.com/webhooks/stateset",
"secret": "REPLACE_WITH_A_RANDOM_SECRET_"
}'
{
"delivered": true,
"status_code": 1,
"duration_ms": 8,
"error": "string"
}
Test Webhook V1
Send a probe POST to verify a webhook URL is reachable. The probe carries the same envelope shape and headers as a real job.completed delivery (with a…
POST
/
api
/
v1
/
webhook-test
curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.computer.stateset.app/api/v1/webhook-test' \
--header "X-API-Key: $STATESET_COMPUTER_USE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"url": "https://example.com/webhooks/stateset",
"secret": "REPLACE_WITH_A_RANDOM_SECRET_"
}'
{
"delivered": true,
"status_code": 1,
"duration_ms": 8,
"error": "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.
job.completed delivery (with a synthetic flat payload
underneath), so the receiver is tested end-to-end before a real
job is queued. Returns delivery status and round-trip latency.
Envelope fields (event_id, event_type, event_timestamp,
api_version) are stamped exactly like production deliveries —
tenants writing receivers against this probe see the same shape
they’ll see when a real job completes.
Request body
WebhookTestRequest
string
required
Webhook URL to probe. http or https only.
string,null
Optional shared secret. When set, the probe carries an
X-Webhook-Signature header signed with the same scheme as production deliveries. Minimum length: 16. Maximum length: 256.Response
WebhookTestResponse
boolean
required
True iff the receiver returned 2xx.
integer,null
HTTP status the receiver returned. None when the request could not complete (network error, timeout).
integer
required
Wall-clock time the probe took, in milliseconds.
string,null
Network / timeout error message when delivery failed.
Status codes
| Code | Meaning |
|---|---|
200 | Successful Response |
422 | Validation Error |
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.computer.stateset.app/api/v1/webhook-test' \
--header "X-API-Key: $STATESET_COMPUTER_USE_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"url": "https://example.com/webhooks/stateset",
"secret": "REPLACE_WITH_A_RANDOM_SECRET_"
}'
{
"delivered": true,
"status_code": 1,
"duration_ms": 8,
"error": "string"
}
Last modified on September 21, 2026