Skip to main content
Sets the simulated connectivity state of one of your zones in the sandbox for a limited time. Sandbox events from that zone then follow the same channel decision as production would in that state, without any message leaving wede. The real state of the zone and your production traffic are never touched.

Authentication

Sandbox API key (wede_test_) only. Any other credential receives 403 sandbox_key_required.

Request body

string
required
Code of a zone linked to your tenant, for example zone_lisbon_central.
string
required
online, degraded, sms_only, voice_only or offline.
integer
default:"60"
How long the simulated state lasts, from 5 to 3600 seconds. When it ends, the zone is online again in the sandbox.

Example

Response

200 OK
string
Zone code.
string
Always sandbox.
string
The simulated state now in effect.
string
When the simulation ends.
If the state changes to or from online, wede sends connectivity.degraded or connectivity.restored with "environment": "sandbox". The return to online when the simulation expires does not send a webhook.

A typical test

  1. Simulate offline for your zone.
  2. Send an event with metadata.zone_id set to that zone, using the sandbox key.
  3. Read it with GET /v1/events/:event_id: channel_used and the lifecycle (notes starting with sandbox:) show the path production would take with your continuity mode and channel cascade.
  4. Check that your webhook endpoint received event.delivered or event.status_changed with "environment": "sandbox".

Errors