Platitun · API · Event subscription · Issue a test receiver address

Issue a test receiver address

POST /api/v1/hooks/probe

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

An address ON THE MARKETPLACE ITSELF that accepts an event and verifies its signature with the very code that produced it. That lets you compare your side against the reference. Issued to the TEST role only — an administrator grants it.

Response fields

Field	Type	What it is
`probeUrl`	`string`	The receiver address. Set it as your delivery address.

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.
`test_only`	The test receiver is issued to the test role only. An administrator grants it.

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
POST /api/v1/hooks/test — A test event
GET /api/v1/hooks/deliveries — The delivery log
GET /api/v1/hooks/probe — What the test receiver got