Platitun · API · Подписка на события · Пробное событие

Пробное событие

POST /api/v1/hooks/test

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

Проверить свою сторону, не дожидаясь живого заказа. Проба идёт ТЕМ ЖЕ путём: та же подпись, тот же журнал, та же лестница попыток — проверка, идущая другим путём, ничего не доказывает.

В теле такого события стоит признак test: true. Проверяйте его: иначе программа примет пробу за настоящий заказ и пойдёт его выдавать.

Поля ответа

Поле	Тип	Что это
`delivery`	`string`	Номер записи журнала — по нему смотреть, что вышло.
`test`	`boolean`	Всегда true.

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

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

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

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

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