Run a test scenario
/sandbox/test-scenarios/{scenario_id}/runsRuns a test scenario in the sandbox. Records created by the scenario have meta.simulated set to true, and the corresponding events are delivered to webhooks and event streams as they would be in production. Scenario parameters can be supplied in params.
Available only with sandbox credentials. Production credentials receive 409 Conflict with the sandbox_required error code.
The run is processed asynchronously. The Location header points to the operation that tracks its progress. The Idempotency-Key header is required; retrying with the same key returns the same operation without running the scenario again.
Resetting the sandbox deletes the data created by scenario runs.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/sandbox/test-scenarios/string/runs" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "attempt": { "number": 0, "status": "running" }, "cancellation_requested": true, "created_at": "2019-08-24T14:15:22Z", "error": {}, "expires_at": "2019-08-24T14:15:22Z", "finished_at": "2019-08-24T14:15:22Z", "id": "string", "items_url": "string", "object": "operation", "progress": { "done": 0, "failed": 0, "total": 0 }, "result_url": "string", "started_at": "2019-08-24T14:15:22Z", "status": "queued", "type": "string" }}