Как добавить и настроить веб-хук

Веб-хук в настройках чат-бота — это метод взаимодействия между платформой NeuroSpace и вашим сайтом или сервисом. Он используется для отправки уведомлений о новых диалогах и сообщениях.

Как работает передача данных по веб-хуку:

• Создание веб-хука — добавление URL, на который будут приходить уведомления. Это может быть сайт, онлайн-сервис или CRM-система.
• Срабатывание ключевого события — новый диалог или новое сообщение в диалоге.
• Отправка HTTP-запроса. Платформа NeuroSpace отправляет HTTP-запрос на указанный URL с информацией о диалоге или сообщении (ID, название диалога, текст сообщения и т. д.).
• Получение запроса другой системой. Сайт или CRM-система после получения запроса приступает к выполнению дальнейших действий, например обновлению данных в сделке или выполнению какого-либо действия.

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

Новый диалог

Если выбрано событие «Новый диалог», то будут передаваться следующие данные:

• uuid — уникальный идентификатор диалога;
• integration_dialogue_name — название диалога. Как правило, это имя пользователя, который написал чат-боту;
• integration_type — ID, или уникальный идентификатор, мессенджера или другого сервиса, с которым интегрирован чат-бот и в котором клиент начал новый диалог с чат-ботом. За каждым сервисом интеграции на платформе NeuroSpace закреплен свой ID.

Также с уведомлением о новом диалоге могут передаваться дополнительные данные. Например:

• amocrm_chat_id — если чат-бот интегрирован с amoCRM, то на его стороне также создается диалог со своим уникальным идентификатором;
• amocrm_source_name — название источника диалога.

Новое сообщение

Если выбрано событие «Новое сообщение», то будут передаваться следующие данные:

• uuid — уникальный идентификатор сообщения;
• dialogue_uuid — уникальный идентификатор диалога;
• integration_dialogue_name — название диалога. Как правило, это имя пользователя, который написал чат-боту;
• message — само сообщение;
• direction — обозначает тип сообщения: входящее (in) или исходящее (out);
• file_url — ссылка на непечатное сообщение, то есть аудиофайл (голосовое сообщение), картинку или видео;
• type — тип сообщения. Чат-боты NeuroSpace помимо текста (тип “text”) обрабатывают следующие типы сообщений: аудио (тип “audio”), изображение (тип “image”), видео (тип “video”).

Остальные функции API доступны по запросу в чат поддержки.