Sandbox Simulations

The sandbox environment is an Enterprise feature.

Overview

The sandbox is designed to build and test an integration against the platform using mocked data. Agents do not read data or write to production websites in sandbox mode. Data cannot be promoted from sandbox to the live environment. Unlike the live environment where jobs run asynchronously, sandbox jobs run synchronously while still delivering results via webhooks. Sandbox API requests are made against:

https://sandbox.deck.co/api/v1

Simulating Authentication & Connections

In sandbox mode, authentication is fully simulated. Any value can be used for username and password fields when running the EnsureConnection job or when a user authenticates through the Auth SDK.

Simulating Job Outcomes

Forced outcomes currently only work on Jobs other than EnsureConnection and CloseConnection.

You can simulate different job outcomes by passing specific values in the x-deck-sandbox header.

curl --location https://sandbox.deck.co/api/v1/jobs/submit \
    --header 'x-deck-client-id: <insert client_id>' \
    --header 'x-deck-secret: <insert secret>' \
    --header 'x-deck-sandbox: <insert value>' \
    --header 'Content-Type: application/json' \

Here is a list of potential results:

Header value	Outcome	Occurrence
`job-failed`	Generic job failure	The job execution failed due to an agent error or unexpected condition.
`error-input-values`	Input validation error	The input provided for the job is invalid, incomplete, or does not match the expected schema.
`error-not-found`	Data not found	The specified resource required for the job could not be found.
`error-system-error`	System error	An unexpected system error occurred during the connection attempt.
`error-action-rejected`	Action rejected	The requested action was rejected by the system or source.
`error-unexpected-error`	Unexpected error	An unexpected error occurred that does not fit into other error categories.

Get Started

Guides

Development

Sandbox Simulations

Overview

Simulating Authentication & Connections

Simulating Job Outcomes

​Overview

​Simulating Authentication & Connections

​Simulating Job Outcomes

Overview

Simulating Authentication & Connections

Simulating Job Outcomes