Skip to navigation
APIWebhooks

Send test event

Queues one webhook.test event to this endpoint, signed and retried like any delivery, whatever its subscription. In a live workspace livemode picks the mode and defaults to live; a sandbox workspace sends test mode only.

Requires the webhooks:write scope. Rate limit: 10 requests per minute per key (the strict lane).

Authentication

AuthorizationBearer

Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.

Path parameters

webhook_idstringRequiredformat: "uuid"
The webhook endpoint's id.

Headers

Idempotency-KeystringOptional<=255 characters

Idempotency token. Retries that reuse the key within 24h replay the original response. Up to 255 characters; a UUID is typical. See Idempotency.

SpreadSpace-VersionstringOptionalformat: "^\d{4}-\d{2}-\d{2}$"

Pin the API version, e.g. 2026-10-07. Omit to get the latest. See Versioning.

Request

This endpoint expects a nullable object.
livemodeboolean or nullOptional

Mode of the test envelope. In a live workspace it defaults to true; a sandbox workspace takes false or nothing.

Response headers

X-Request-IDstringOptional
Correlation ID for this request. Quote it in support tickets.
Idempotency-Replayboolean

Set to true when the response is replayed from the idempotency cache for a request that re-presented an Idempotency-Key it had already used. Absent on the original (winner) response. A replay repeats the original status and body. When the original could not be stored (an unhandled server fault, or a body over the 1 MiB replay cap) the replay is an error envelope that says so; the operation is never re-run under the same key.

SpreadSpace-VersionstringOptional

The API surface version the server resolved for this request. Always present, regardless of whether the client supplied the request-side SpreadSpace-Version header. Default: 2026-10-07.

RateLimit-Limitinteger

Request budget of the endpoint’s rate-limit policy per 60-second sliding window. See Rate limits.

RateLimit-Remaininginteger

Requests left in the current window. Suppressed on 429 responses produced outside the rate limiter (for example a usage throttle), where a remaining budget would be misleading.

RateLimit-Resetinteger

Seconds until a guaranteed-fresh window.

RateLimit-PolicystringOptional

The active policy in limit;w=window-seconds form.

Response

OK
delivery_idstringformat: "uuid"
The delivery to watch in the endpoint's deliveries list.
event_refstring

The event id as it will be delivered (evt_…): the envelope’s id, the SpreadSpace-Event-Id header and the deliveries list’s event_ref.

livemodeboolean

The envelope’s livemode.

scheduled_atdatetime
When the first attempt is due.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error