Webhooks

Вебхук — это способ оповещения о произошедшем в системе событии с помощью пользовательских обратных вызовов по HTTP.

Настройте вебхук в разделе enKod ➔ Настройки, чтобы получать уведомления о событиях на свой URL.

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

На данный момент доступны POST запросы для событий:

Сообщение отправлено (только канал Email)
Oшибка доставки (только канал Email)
Открытие сообщения (только канал Email)
Клик в сообщении (только канал Email)
Жалоба (только канал Email)
Подписка на группу рассылок (только канал Email)
Отписка от группы рассылок (только канал Email)
Добавление контакта

Тело фиксировано и выглядит следующим образом:

Сообщение отправлено

{
  "event": "message sent",
  "message_id": 4,
  "message_uid": "0123456789_012_012_01234",
  "sending_type": "instant",
  "name": "Sending message (test)",
  "from": "[email protected]",
  "to": "[email protected]"
}

где

event - событие (сообщение отправлено)
message_id - идентификатор сообщения
message_uid - уникальный uid сообщения
sending_type - условие отправки сообщения
- instant - мгновенное
- scheduled - запланированное
- regular - регулярное
- byAPI - по API
- byEvent - по событию
- DOI - письмо-подтверждение
- scenario - сообщение сценария
name - тема сообщения
from - емейл отправителя
to - емейл получателя

Ошибка доставки

{
  "event": "delivery bounce",
  "message_id": 4,
  "message_uid": "0123456789_012_012_01234",
  "sending_type": "instant",
  "name": "Error while sending message (test)",
  "from": "[email protected]",
  "to": "[email protected]",
  "error_message": "Some error message"
}

где

event - событие (ошибка доставки)
message_id - идентификатор сообщения
message_uid - уникальный uid сообщения
sending_type - условие отправки сообщения
- instant - мгновенное
- scheduled - запланированное
- regular - регулярное
- byAPI - по API
- byEvent - по событию
- DOI - письмо-подтверждение
- scenario - сообщение сценария
name - тема сообщения
from - емейл отправителя
to - емейл получателя
error_message - текст ошибки

Открытие сообщения

{
  "event": "message open",
  "message_id": 4,
  "message_uid": "0123456789_012_012_01234",
  "sending_type": "instant",
  "name": "Open message (test)",
  "from": "[email protected]",
  "to": "[email protected]"
}

где

event - событие (открытие сообщения)
message_id - идентификатор сообщения
message_uid - уникальный uid сообщения
sending_type - условие отправки сообщения
- instant - мгновенное
- scheduled - запланированное
- regular - регулярное
- byAPI - по API
- byEvent - по событию
- DOI - письмо-подтверждение
- scenario - сообщение сценария
name - тема сообщения
from - емейл отправителя
to - емейл получателя

Клик в сообщении

{
  "event": "message clicked",
  "message_id": 4,
  "message_uid": "0123456789_012_012_01234",
  "sending_type": "instant",
  "name": "Click in message (test)",
  "from": "[email protected]",
  "to": "[email protected]",
  "click_url": "https://clicked.link/"
}

где

event - событие (клик в сообщении)
message_id - идентификатор сообщения
message_uid - уникальный uid сообщения
sending_type - условие отправки сообщения
- instant - мгновенное
- scheduled - запланированное
- regular - регулярное
- byAPI - по API
- byEvent - по событию
- DOI - письмо-подтверждение
- scenario - сообщение сценария
name - тема сообщения
from - емейл отправителя
to - емейл получателя
click_url - URL клика

Жалоба

{
  "event": "сomplaint",
  "message_id": 4,
  "message_uid": "0123456789_012_012_01234",
  "sending_type": "instant",
  "name": "Complaint in message (test)",
  "from": "[email protected]",
  "to": "[email protected]"
}

где

event - событие (жалоба)
message_id - идентификатор сообщения
message_uid - уникальный uid сообщения
sending_type - условие отправки сообщения
- instant - мгновенное
- scheduled - запланированное
- regular - регулярное
- byAPI - по API
- byEvent - по событию
- DOI - письмо-подтверждение
- scenario - сообщение сценария
name - тема сообщения
from - емейл отправителя
to - емейл получателя

Подписка на группу рассылок

{
  "event": "mailing group subscribe",
  "email": "[email protected]",
  "group_id": 4,
  "group_name": "Person subscribe (test)",
  "channel": "email"
}

где

event - событие (подписка на группу рассылок)
email - емейл контакта
group_id - идентификатор группы рассылок
group_name - системное имя группы рассылок
channel - канал группы рассылок

Отписка от группы рассылок

{
  "event": "mailing group unsubscribe",
  "email": "[email protected]",
  "group_id": 4,
  "group_name": "Person unsubscribe (test)",
  "channel": "email"
}

где

event - событие (отписка от группы рассылок)
email - емейл контакта
group_id - идентификатор группы рассылок
group_name - системное имя группы рассылок
channel - канал группы рассылок

Добавление контакта

{
  "event": "contact adding",
  "email": "[email protected]",
  "phone": "80123456789",
  "groups_names": [
    "test_group_0",
    "test_group_1"
  ],
  "groups_ids": [
    0,
    1
  ]
}

где

event - событие (добавление контакта)
email - емейл контакта
phone - телефон контакта
groups_names - системные имена групп рассылок, на которые был подписан контакт при добавлении
groups_ids - идентификаторы групп рассылок, на которые был подписан контакт при добавлении