Вебхуки

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

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

Принцип работы

1. Вы создаете конечную точку вебхука в своем приложении, которая принимает POST-запросы
2. Вы регистрируете URL в панели управления Emailit или через API
3. При возникновении подписанного события Emailit отправляет POST-запрос на ваш URL с данными события
4. Ваша конечная точка отвечает статус-кодом 2xx для подтверждения получения

Структура события

Каждое событие вебхука имеет единообразную структуру:

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.delivered",
  "data": {
    "object": {
      ...
    }
  }
}

{
  "event_id": "evt_2bH7kNwP5mQaV1sXgIdKe6pZr",
  "type": "email.delivered",
  "data": {
    "object": {
      ...
    }
  }
}

Доступные события

Emailit отправляет уведомления вебхуков для следующих типов ресурсов:

• Письма — события жизненного цикла доставки (принято, доставлено, отклонено и т.д.)
• Домены — создание, обновление и удаление доменов
• Аудитории — события управления аудиториями
• Подписчики — события жизненного цикла подписчиков
• Контакты — события управления контактами
• Шаблоны — создание, обновление и удаление шаблонов
• Подавления — изменения в списках подавления
• Проверки email — результаты проверки
• Списки проверки email — события массовой проверки списков

Полный список см. в разделе Типы событий.

Дальнейшие шаги

• Типы событий — Полный список всех доступных типов событий
• Запросы вебхуков — Структура HTTP-запросов вебхуков
• Подпись запроса — Проверка подлинности вебхуков с помощью подписей