Platitun · API · Подписка на события · Выдать адрес служебного приёмника

Выдать адрес служебного приёмника

POST /api/v1/hooks/probe

Область ключа: hooks · изменяет данные, нужен заголовок Idempotency-Key

Адрес НА САМОЙ ПЛОЩАДКЕ, который принимает событие и проверяет подпись тем же кодом, которым её ставили. Так свою сторону можно сверить с образцом. Выдаётся ТОЛЬКО тестовой роли — её ставит администратор.

Поля ответа

Поле	Тип	Что это
`probeUrl`	`string`	Адрес приёмника. Поставьте его адресом доставки.

Поводы отказа

Отказ по правилам приходит как {"error":"rejected","refusal":{"kind":"…"}} с кодом 409. Общие для всех путей отказы — в разделе правил.

Код	Что случилось и что делать
`not_found`	Записи нет или она не ваша. Условие владения стоит в самом запросе к базе, поэтому чужая запись выглядит как отсутствующая.
`test_only`	Служебный приёмник выдаётся только тестовой роли. Её ставит администратор.

Рядом в этом разделе

GET /api/v1/hooks — Своя подписка на события
PUT /api/v1/hooks — Задать адрес и события
DELETE /api/v1/hooks — Отключить доставку
POST /api/v1/hooks/secret — Заменить секрет подписи
POST /api/v1/hooks/resume — Включить доставку снова
POST /api/v1/hooks/test — Пробное событие
GET /api/v1/hooks/deliveries — Журнал доставки
GET /api/v1/hooks/probe — Что принял служебный приёмник