Platitun · API · Event subscription · A test event

A test event

POST /api/v1/hooks/test

Key scope: hooks · changes data, the Idempotency-Key header is required

Check your side without waiting for a live order. The probe travels the SAME way: same signature, same log, same retry ladder — a check that goes a different way proves nothing.

The body of such an event carries test: true. Check it: otherwise your program will take the probe for a real order and go deliver it.

Response fields

Field	Type	What it is
`delivery`	`string`	The log record id — look it up to see the outcome.
`test`	`boolean`	Always true.

Refusal reasons

A rule refusal arrives as {"error":"rejected","refusal":{"kind":"…"}} with status 409. Refusals common to all endpoints are in the rules section.

Code	What happened and what to do
`not_found`	The record does not exist or is not yours. The ownership condition is in the database query itself, so someone else’s record looks like a missing one.

Nearby in this section

GET /api/v1/hooks — My event subscription
PUT /api/v1/hooks — Set the address and events
DELETE /api/v1/hooks — Turn delivery off
POST /api/v1/hooks/secret — Rotate the signing secret
POST /api/v1/hooks/resume — Turn delivery back on
GET /api/v1/hooks/deliveries — The delivery log
POST /api/v1/hooks/probe — Issue a test receiver address
GET /api/v1/hooks/probe — What the test receiver got