Sandbox

Fire a test webhook

Sends one signed test event to each enabled endpoint of this application that subscribes to it, through the real delivery pipeline: the sandbox signing secret, the same headers, the delivery log and the retries. The payload carries test: true. With orderId, the event describes that sandbox order of this application, with its real id and store, and the response's order shows what was sent. Sandbox keys only, and nothing is built.

post/sandbox/webhooks/fire

Request

  • Base URL: https://api.layout.link/v1
  • URL: https://api.layout.link/v1/sandbox/webhooks/fire
  • Auth: HTTP bearer

Headers

Layout-Version'2026-10-01'

The API version you code against. Optional; without it you get 2026-10-01, the current version. Layout answers with the version it used.

Idempotency-Keystring

Optional. Any 1 to 255 visible ASCII characters, unique per real intent. A retry with the same key and the same body gets the stored response for 24 hours, with Idempotent-Replayed: true, and is never run twice. The same key with a different body is 409 idempotency_conflict; while the first request is still running it is 409 in_progress with Retry-After. Only a success is stored: any error releases the key so it can be sent again. A 4xx ran nothing. A 5xx may have run, above all a confirm's 500, so read the resource before sending anything changed.

Request body

event'order.building' | 'order.carted' | 'order.placing' | 'order.placed' | 'order.failed' | 'order.unconfirmed' | 'order.challenge' | 'order.updated' required

The event to send. order.needs_approval is reserved and never sent, so it cannot be fired.

orderIdstring

Example request

{
  "orderId": "ord_7c21e4b9a0d3"
}

Response

Sent. Read each delivery's outcome.

event'order.building' | 'order.carted' | 'order.placing' | 'order.placed' | 'order.failed' | 'order.unconfirmed' | 'order.challenge' | 'order.updated' required

Changes

No recorded changes to this operation across all 1 revision of this API.