Retrieve a test scenario
/sandbox/test-scenarios/{scenario_id}Retrieves a test scenario from the sandbox catalog, including the parameters it accepts and the effects it produces. Scenario IDs use the scn_ prefix.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/sandbox/test-scenarios/string"{ "data": { "description": "string", "effects": [ "string" ], "id": "string", "name": "string", "object": "test_scenario", "params": null, "version": 0 }}List test scenarios GET
Returns the complete catalog of sandbox test scenarios in a single response while preserving the standard collection response format. The catalog is the same for production and sandbox credentials.
Run a test scenario POST
Runs 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.