Platitun · API · Event subscription · Rotate the signing secret

Rotate the signing secret

POST /api/v1/hooks/secret

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

A new secret instead of the old one, shown once. The previous one is dead from this second: your signature check will stop matching until the new secret reaches it.

Response fields

Field	Type	What it is
`secret`	`string`	The new secret — for the first and last time.

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.
`vault_off`	The marketplace vault is not configured, so there is nowhere to keep secrets. That is our problem, not yours: contact support.

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/resume — Turn delivery back on
POST /api/v1/hooks/test — A test event
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