Skip to content
Vendrix
Sign in

Sandbox events

Trigger a synthetic webhook event to test your receiver, without waiting for real traffic.

These examples use a placeholder address. Your console shows the exact address of the API for your workspace.

POST /sandbox/events

Queues one synthetic event to the active sandbox endpoints of the application that subscribe to its type. A live key gets 403 sandbox_only.

  • The response says how many deliveries were queued. queued_deliveries is 0 when no endpoint subscribes.
Required scope
sandbox.events.write
HTTP
Success: HTTP 201
Sandbox
Sandbox keys only

Parameters

Parameters
NameDescription
type

string (an event type)
Body · Required

Any event type except developer.application.created.

Errors

Any authenticated endpoint can also return the authentication, scope and rate limit errors listed on the errors page.

Request

curl -X POST "https://api.vendrix.net/v1/sandbox/events" \
  -H "Authorization: Bearer $VENDRIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "message.received"
  }'

Response

201 Created
{
  "event_id": "evt_4f1c2b9a0d7e6f5a4b3c2d1e",
  "queued_deliveries": 1
}