Вебхук для изменения статуса подписки

Что такое изменение статуса подписки? #

Изменение подписки регистрируется, когда email-адрес добавляется в стоп-список (Suppression list) канала или удаляется из него. Адрес добавляется в стоп-список после жесткого возврата, жалобы на спам или вручную — в веб-интерфейсе Haskimail или с помощью API.

О ручном добавлении и удалении вебхук сообщает всегда. О жестком возврате и жалобе на спам — только если у этого же вебхука включены события «Возвраты» (Bounce) и «Жалобы на спам» (SpamComplaint): событие изменения подписки отправляется вслед за ними.

Адрес удаляется из стоп-списка вручную — путем его повторной активации в веб-интерфейсе Haskimail или с помощью API.

Вы также можете получить адреса из стоп-спика с помощью API.

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

Настройка URL вебхука для изменения статуса подписки #

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

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

Через API

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

Данные вебхука для изменения статуса подписки #

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

Когда адрес добавлен или убран вручную, событие не связано с письмом: message_id и campaign_id пустые, поля custom_vars нет.

event	string	Тип события: `subscriptionchange`.
recipient	string	Адрес получателя, статус которого изменился.
email	string	То же, что `recipient`.
SuppressSending	string	Строка `"true"` — адрес добавлен в стоп-лист, `"false"` — убран из него.
SuppressionReason	string	Причина: `HardBounce` — жесткий возврат, `SpamComplaint` — жалоба на спам, `ManualSuppression` — адрес добавлен или убран вручную, в интерфейсе или через API.
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": "subscriptionchange",
  "recipient": "angry@example.com",
  "email": "angry@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",
  "SuppressionReason": "SpamComplaint",
  "SuppressSending": "true"
}

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

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

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

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

curl <your-url> \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{
  "event": "subscriptionchange",
  "recipient": "angry@example.com",
  "email": "angry@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",
  "SuppressionReason": "SpamComplaint",
  "SuppressSending": "true"
}'

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

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

Получать одно событие о том, что адрес перестал принимать письма, — после жесткого возврата, жалобы на спам или ручного добавления в стоп-лист.
Вести собственный список исключений.
Уведомлять пользователя в вашем приложении о том, что его адрес в данный момент активен или неактивен.

Обзор

Интеграции

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

Справочник API

Вебхуки