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.
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
- Simulate
offlinefor your zone. - Send an event with
metadata.zone_idset to that zone, using the sandbox key. - Read it with
GET /v1/events/:event_id:channel_usedand thelifecycle(notes starting withsandbox:) show the path production would take with your continuity mode and channel cascade. - Check that your webhook endpoint received
event.deliveredorevent.status_changedwith"environment": "sandbox".
