Вебхук о доставке

Что такое вебхук о доставке? #

Вебхук о доставке — это способ, которым Haskimail уведомляет ваше приложение об успешной доставке письма на сервер получателя. Это может быть полезно в самых разных ситуациях: например, чтобы предоставлять вашим клиентам информацию о доставке в реальном времени, измерять, сколько времени требуется письму, чтобы дойти до почтового ящика, или просто для аудита.

В Haskimail письмо считается успешно доставленным, когда почтовый сервер получателя возвращает ответ «ОК» после попытки доставки. Когда это происходит, Haskimail добавляет подтверждение о доставке для этого конкретного письма (и конкретного получателя, так как их может быть несколько). Одновременно с этим, если вебхук включен, на URL вашего вебхука о доставке отправляется POST-запрос. Обратите внимание, что в этот момент письмо покидает зону ответственности Haskimail, и сервер-получатель еще должен доставить письмо в почтовый ящик пользователя. Обычно это происходит мгновенно, но в редких случаях, например, при наличии внутреннего файрвола, письма могут быть поставлены в очередь сервером-получателем.

Вы также можете использовать API Сообщений, чтобы запрашивать (pull) данные о доставке, но с вебхуком Haskimail сам отправляет (push) вам эту информацию по мере ее поступления. Вебхук о доставке отправляет данные в ваше приложение в простом для разбора (парсинга) формате JSON.

Примечание: дата и время события передаются в полях event_time (московское время) и event_time_utc (UTC) в формате ГГГГ-ММ-ДД ЧЧ:ММ:СС.

Настройка URL вебхука о доставке #

Через веб-интерфейс Haskimail

Войдите в аккаунт Haskimail, выберите нужный Сервер и Канал, а затем перейдите на вкладку «Вебхуки». Нажмите «Добавить вебхук», введите URL в поле «URL вебхука» и установите флажок напротив события «Доставка» (Delivery).

Через API

Вы можете настроить событие Delivery с помощью API как при создании нового вебхука, так и при редактировании уже существующего.

Данные вебхука о доставке #

Haskimail отправляет на URL вебхука POST-запрос с заголовком Content-Type: application/json. Пример тела запроса показан справа. Все значения, кроме server_id, передаются строками.

event	string	Тип события: `delivered`.
recipient	string	Адрес получателя, которому доставлено письмо.
email	string	То же, что `recipient`.
message_id	string	ID письма — `MessageID` из ответа на отправку.
campaign_id	string	Тег письма (`Tag`). Без тега — пустая строка.
custom_vars	string	Метаданные письма (`Metadata`) — строка с JSON. Если метаданные не передавались, строка пустая или поля нет.
server_id	integer	ID сервера, через который отправлено письмо.
stream_id	string	ID канала, через который отправлено письмо.
event_time	string	Когда письмо доставлено: московское время, `ГГГГ-ММ-ДД ЧЧ:ММ:СС`.
event_time_utc	string	То же время в UTC.
user_id	string	ID вашего аккаунта.
member_id	string	Служебный ID получателя.
secret	string	Подпись события — см. защиту вебхука.
code, description, error, bounce_category	string	Заполняются только в вебхуке для возвратов, здесь — пустые строки.

Пример JSON данных вебхука

{
  "event": "delivered",
  "recipient": "ivan@example.com",
  "email": "ivan@example.com",
  "message_id": "a41d7c9e2b6f4e0d8c3b5a1f9e7d2c60",
  "code": "",
  "description": "",
  "error": "",
  "bounce_category": "",
  "user_id": "48213",
  "campaign_id": "orders",
  "member_id": "0",
  "event_time": "2026-10-07 14:30:15",
  "event_time_utc": "2026-10-07 11:30:15",
  "secret": "5f2b0c1d9a7e4c3b8d6f1a2e3c4b5d6e",
  "custom_vars": "{\"order_id\":\"1042\"}",
  "server_id": 11834,
  "stream_id": "2081"
}

Тестирование вебхука о доставке с помощью curl #

Если вы ведете разработку на локальной машине или у вашего обработчика еще нет публичного адреса, отправьте на него запрос, показанный справа: он повторяет то, что присылает Haskimail. Замените <your-url> на адрес обработчика.

Тестовое событие на уже настроенный URL можно отправить и из интерфейса: Сервер → Канал → «Вебхуки» → «Отправить тест».

Пример вызова curl

curl <your-url> \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
  "event": "delivered",
  "recipient": "ivan@example.com",
  "email": "ivan@example.com",
  "message_id": "a41d7c9e2b6f4e0d8c3b5a1f9e7d2c60",
  "code": "",
  "description": "",
  "error": "",
  "bounce_category": "",
  "user_id": "48213",
  "campaign_id": "orders",
  "member_id": "0",
  "event_time": "2026-10-07 14:30:15",
  "event_time_utc": "2026-10-07 11:30:15",
  "secret": "5f2b0c1d9a7e4c3b8d6f1a2e3c4b5d6e",
  "custom_vars": "{\"order_id\":\"1042\"}",
  "server_id": 11834,
  "stream_id": "2081"
}'

Как можно использовать данные о доставках #

Существует множество способов использования данных, которые предоставляет вебхук о доставке:

Мгновенно узнавать о доставке письма, чтобы инициировать дальнейшие действия на основе этого события.
Использовать данные для создания статистики, специфичной для вашего приложения.
Предоставлять пользователям интерфейс, позволяющий им отслеживать, что произошло с их email-уведомлениями.
Использовать данные для анализа скорости доставки ваших писем.

Обзор

Интеграции

Руководство пользователя

Справочник API

Вебхуки