Перейти к основному содержимому

Веб-хук

Триггер запускает воркфлоу при получении входящего HTTP-запроса на уникальный URL. Это основной способ интеграции с внешними сервисами, которые умеют отправлять вебхуки — Stripe, GitHub, Telegram и другие.

Настройка

Шаг 1. Создать вебхук

При добавлении ноды в воркфлоу поле Вебхук будет пустым.

Пустая нода Вебхук

Введите slug — уникальное имя пути — и нажмите CREATE WEBHOOK.

Создание вебхука

подсказка

Slug может содержать только латинские буквы, цифры и дефисы. Например: payment-success, new-order, telegram-bot.

Шаг 2. Скопировать URL

После создания нода покажет два URL:

Нода после создания вебхука

URLКогда использовать
Production URLКогда воркфлоу активирован — обрабатывает реальные запросы
Test URLКогда тестируете в редакторе вручную
important

Используйте правильный URL в настройках внешнего сервиса. Production URL работает только когда воркфлоу активирован.

Шаг 3. Настроить параметры (опционально)

Нажмите иконку карандаша рядом с параметрами чтобы открыть форму редактирования.

Форма редактирования вебхука

ПараметрОписание
АутентификацияСпособ защиты вебхука (см. ниже)
HTTP методМетод запроса: GET, POST, PUT, DELETE, PATCH
ПутьSlug вебхука (задаётся при создании)
ОтветКогда отправлять ответ: Сразу или после завершения воркфлоу
Код ответаHTTP-код ответа, по умолчанию 200
Options (JSON)Дополнительные параметры в формате JSON

Аутентификация

Вебхук можно защитить одним из четырёх способов:

  • Нет — публичный доступ, любой запрос будет принят
  • Базовая аутентификация — требует логин и пароль в заголовке Authorization: Basic ...
  • Аутентификация через заголовок — требует наличие определённого заголовка с заданным значением (например, X-Secret-Token)
  • Аутентификация EMD Cloud — принимает только запросы с валидным JWT-токеном пользователя EMD Cloud
примечание

Для использования Базовой аутентификации и Аутентификации через заголовок необходимо предварительно создать соответствующие Credentials в разделе Интеграции вашего проекта: https://console.cloud.emd.one/app/{app-id}/integrations/

Включить прослушивание

Кнопка Включить прослушивание в шапке ноды активирует ожидание входящего запроса в режиме тестирования. После получения запроса воркфлоу выполнится один раз и данные появятся в выходе ноды.

Выходные данные

Нода передаёт в воркфлоу всё содержимое входящего запроса:

{
"headers": { "content-type": "application/json" },
"params": {},
"query": { "utm": "email" },
"body": { "event": "payment.success", "amount": 1500 }
}
примечание

Список всех созданных вебхуков доступен в разделе API вашего проекта в консоли.