API
API ReferenceTestWebhooks

Send test webhook

Delivers a real, signed, retried event to this connection's enabled endpoints, so you can exercise your consumer before an order exists. The payload carries `testMode: true` and describes nothing that happened.

POST
/v1/test/webhooks

Delivers a real, signed, retried event to this connection's enabled endpoints, so you can exercise your consumer before an order exists. The payload carries testMode: true and describes nothing that happened.

Authorization

apiKey
AuthorizationBearer <token>

An API connection key, sent as Authorization: Bearer <key>. The x-api-key header is accepted as an alternative.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/v1/test/webhooks" \  -H "Content-Type: application/json" \  -d '{    "event": "order.created"  }'
{  "deliveries": 0}

Transition test order POST

Warehouses and payment move a real order, none of which you can trigger, so a test order is driven from here instead. Each transition updates what `GET /v1/orders/{orderId}` returns and delivers the matching webhook for real, signed and logged, with `testMode: true` in the payload. Only `test_` orders can be transitioned.

account-unavailable

The Supliful account behind this key can no longer use the API.