Вебхук по правилам Nextbot

Способ подключения "Вебхук по правилам Nextbot" можно использовать, когда внешний сервис может отправлять вебхук в предопределенном JSON-формате. Это удобный способ интеграции, не требующий написания скрипта-адаптера.

Конфигурация

Ссылка вебхука

URL-адрес (endpoint) для получения вебхука находится в поле "Ссылка вебхука" на главной странице интеграции. Используйте этот URL для отправки POST-запросов с данными вебхука.

Пример:

https://app.nextbot.ru/api/webhooks/v1/682db757-7981-4bd4-8bb4-61bd1665a29/923ef269bf224bacadafb5ab05a2e75

Если необходимо обновить токен (например, при компрометации старого), нажмите кнопку "Обновить токен". Прежний URL станет недействительным.

Формат входящего JSON

Для работы с типом подключения "Вебхук по правилам Nextbot" POST-запросы должны содержать JSON-тело со строго определенной структурой и обязательными полями.

Список обязательных и опциональных полей, их описание и пример запроса доступны на главной странице интеграции.

circle-info

Для включения режима отладки добавьте параметр ?debug=true к URL вебхука. В ответе вы получите подробные логи выполнения запроса.

Типы сообщений (message_type)

В зависимости от значения message_type сообщение будет обработано по-разному. Доступны четыре типа, каждый из которых определяет, как сообщение появится в диалоге:

Имитация входящего сообщение от клиента (не будет отправлено клиенту в диалог)

Отправка тестового запроса

Для примера используем JSON с типом сообщения message_type = "notification", который имитирует входящее сообщение от пользователя:

Отправим на наш URL и получим ответ:

200 OK "Webhook received and queued for processing" — значит вебхук успешно отправлен

На скриншоте показан результат обработки вебхука: в диалоге появилось входящее сообщение от клиента, как если бы оно было отправлено через обычный канал связи.

Last updated

Was this helpful?