Top.Mail.Ru

Webhook в CogaSystem: передача событий рассылки во внешнюю систему

Как выбрать типы сообщений и события для Webhook в CogaSystem и подготовить безопасную обработку во внешней системе.

Webhook передаёт информацию о событии на подготовленный адрес внешней системы. Он нужен, например, чтобы CRM учитывала отказ от рассылки или результат доставки. Это не тот же Webhook, который используется для передачи заявки с сайта в базу.

Где находится функция

Откройте «Автоматизация» → «Webhook» и форму добавления. В ней предусмотрены название, URL, типы сообщений и события.

Форма Webhook: URL, источники сообщений и события
Форма Webhook: URL, источники сообщений и события

Порядок действий

  1. Определите получателя событий. Разработчик должен подготовить серверный обработчик и согласовать, какие данные нужны CRM.
  2. Укажите название и URL. Используйте понятное имя интеграции и защищённый адрес обработчика, принадлежащего вашей системе.
  3. Выберите типы сообщений. В форме доступны рассылки, единый шаблон, триггеры и API. Оставьте необходимые источники.
  4. Выберите события. Доступны доставка, недоставка, пропуск, открытие, переход, отписка и жалоба на спам.
  5. Проверьте обработчик. Согласуйте с разработчиком формат поступающих данных, защиту доступа, журналирование и обработку возможных повторов.
  6. Сохраните и проведите ограниченный тест. Проверьте появление ожидаемого события во внешней системе и его связь с нужным контактом.

Что проверить по результату

Форма настройки не является описанием API-контракта. Структуру запроса, способ проверки подлинности и поведение при ошибке нужно сверить с действующей документацией или поддержкой до разработки обработчика. Не предполагайте наличие подписи или гарантированной повторной доставки, если это не подтверждено.

Проверка перед завершением

  • Выбраны только необходимые события.
  • URL ведёт на контролируемый обработчик.
  • Согласованы формат и защита данных.
  • Контрольное событие обработано без повторного действия.
Обратите внимание. Webhook может содержать данные получателей. Не направляйте рабочие события в публичный сборщик запросов и не публикуйте секретные адреса обработчиков.