Skip to main content
POST
Fire Sandbox Event

Authorizations

X-API-Key
string
header
default:sk_live_your_api_key_here
required

Workspace-scoped API key. Format: sk_live_{64 hex chars}

Body

application/json

Request model for firing a synthetic sandbox webhook event.

eventType
enum<string>
required

The webhook event type to fire.

Available options:
asset.processing.completed,
asset.processing.failed
submissionId
string<uuid>
required

Submission UUID to embed in the event payload.

errorMessage
string | null

Error message forwarded to subscribers for 'asset.processing.failed' events. Defaults to 'Sandbox simulated failure' when omitted.

Response

Successful Response

Response model for a fired sandbox event.

dispatched
integer
required

Number of webhook subscriptions notified.