API
ДокументацияAPI и интеграции

Вебхуки OTP-проекта

Получать события доставки и проверки кода на свой сервер.

WAIX API · Обновлено 22 сентября 2026

Подключение

  1. В разделе OTP выберите проект и сохраните публичный HTTPS-адрес в блоке «Вебхук проекта».
  2. Выберите нужные события и сохраните секрет подписи. Он показывается один раз.
  3. Нажмите «Проверить доставку» и проверьте HTTP-ответ в таблице.

События

СобытиеЗначение
otp.sentMeta приняла отправку. В sandbox это имитация без сообщения.
otp.deliveredСообщение доставлено получателю.
otp.readПолучатель прочитал сообщение; этот статус может не поступить.
otp.verifiedВаш сервер успешно проверил введённый код.
otp.failedОтправка завершилась подтверждённой ошибкой.

В событии есть project_id, id отправки, recipient, mode и временные отметки. Самого кода нет. Не считайте delivered или read успешной авторизацией.

Подпись и повторы

Проверяйте HMAC-SHA256 от строки timestamp + "." + исходное тело HTTP-запроса. Секрет берите у выбранного проекта. Заголовки: X-Waix-Timestamp и X-Waix-Signature с префиксом v1=. Проверяйте допустимый возраст timestamp и сравнивайте подпись за постоянное время. Идентификатор id события используйте для удаления повторов.

Верните 2xx после сохранения события в свою очередь. Повторы и журнал доставки работают так же, как для вебхуков сообщений. После замены секрета обновите его на принимающем сервере.

Остался вопрос по этой инструкции?Написать в поддержку →