Fire Sandbox Event
API Endpoints
Fire Sandbox Event
Trigger a synthetic webhook event without running a real submission.
Looks up all assets in the submission and dispatches one event per asset to
all active subscriptions in the identity's workspace that subscribe to the
given event type. No credits are consumed. Useful for end-to-end testing
of your webhook handler before going live.
Authentication: Requires X-API-Key header with a sandbox (sk_test_) key.
Args:
request_data: Event type and submission ID to target.
For ``asset.processing.failed`` events an optional ``error_message`` is
forwarded to subscribers; defaults to "Sandbox simulated failure".
Returns:
FireSandboxEventResponse with the total count of subscriptions notified
across all assets.
Raises:
403: If the API key is not a sandbox (sk_test_) key.
404: If the submission is not found in the authenticated workspace.
422: If the request body fails validation.
Example:
POST /api/v1/integrations/sandbox/events/fire
{
"eventType": "asset.processing.completed",
"submissionId": "550e8400-e29b-41d4-a716-446655440000"
}
Response (200):
{ "dispatched": 2 }
POST
Fire Sandbox Event
Authorizations
Workspace-scoped API key. Format: sk_live_{64 hex chars}
Body
application/json
Request model for firing a synthetic sandbox webhook event.
The webhook event type to fire.
Available options:
asset.processing.completed, asset.processing.failed Submission UUID to embed in the event payload.
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.
Number of webhook subscriptions notified.