Чат-боты через Webhook/API

Интеграция позволяет подключить ваши рабочие сервисы к мессенджеру и получать уведомления прямо в чаты Пачки.

Выглядит это следующим образом: в Пачке создается бот, который получает информацию из сервиса, который вы подключили. Также бот может отреагировать на команды и отправить ответ обратно в сервис, подключенный к Пачке. Такого бота вы можете добавить в любой чат, куда он будет отправлять сообщения о событиях.

Какие сервисы можно подключить по интеграции с Webhook

Проверьте, если сервис, которым вы пользуетесь поддерживает исходящие Webhook, то его можно без проблем подключить к Пачке. Так, например, можно подключить к Пачке вашу CRM (Битрикс24, 1-С, AmoCRM) и получать оттуда уведомления о продажах/подписках. Или настроить получение уведомлений из вашего сервиса для управления проектами (Jira, Confluence), чтобы понимать, какие изменения там происходят.

Тут широкие возможности для ваших сценариев, которые мы никак не ограничиваем)‍

События, отображаемые ботом

Это могут быть текстовые уведомления, картинки или сообщения о каких-нибудь событиях. Например, при интеграции с GitLab пользователю приходят уведомления о том, что кто-то поменял параметры проекта.

Кто может создавать интеграции с Webhook

Интеграцию может создать любой сотрудник. Он может сделать ее приватной или разрешить пользоваться ей своим коллегам. Делается это с помощью настроек, о них расскажем ниже.

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

Как настроить чат-бота через Webhook/API

1. Создайте новую интеграцию Webhook:

1. Откройте раздел “Автоматизации” в левом боковом меню
2. Выберите подраздел “Интеграции”
3. В витрине интеграций найдите Webhook и нажмите на карточку
4.Нажмите “+”, чтобы добавить новую интеграцию

2. Настройте основные параметры чат-бота

  1. Выберите, где будет использоваться бот: для одного чата или для нескольких.
  2. Придумайте название боту и поставьте логотип сервиса, который подключаете. Это как имя и аватарка пользователя - по ним будет легко добавить бота в чат и идентифицировать его, когда он будет присылать сообщения.
  3. Выберите тех, кто сможет настраивать бота. Они увидят его в своем разделе интеграций и смогут менять настройки.
  4. Выберите тех, кто сможет добавлять вашего бота в чаты. Эти пользователи смогут добавлять бота в чаты и получать от него сообщения

3. Настройте раздел "Входящий вебхук", если хотите получать уведомления из сервиса

  1. Скопируйте “Webhook URL”. Это aдрес Пачки, на который внешний сервис будет присылать информацию.
  2. Для отправки сообщений настройте выполнение POST запросов на указанный Webhook URL с JSON: { "message": "Текст сообщения"} или заполните Mustache-шаблон.
  3. Заполните Mustache-шаблон. В нем прописываются фразы, которыми будет говорить бот :)
    - Откройте параметры webhook для сервиса, который хотите подключить. Обычно они располагаются на сайте в разделе “for developers” и содержат информацию о событиях, которые можно отправить в Пачку.
    - Выберите события, которые хотите получать в чаты Пачки. Например, это может быть значение суммы заказа в CRM или сроки выполнения задачи в таск-трекере.
    - Внесите эти поля в Mustache-шаблон вместе с текстом, который будет присылать бот. Пример заполненного поля можно посмотреть на картинке выше)
    - Не забудьте заключить значение поля в двойные Mustache - скобочки в форме усов {{ }}.
    💡 Подробнее про возможности mustache можно почитать тут.

4. Настройте раздел "Исходящий вебхук", если хотите, чтобы бот реагировал на команды

  1. Вставить url-адрес (webhook) сервиса, на который Пачка будет отправлять сообщения.
  2. Пропишите команды. По ним бот поймет, что это сообщение надо отправлять. Компанды должны начинаться с / и быть на английском языке.

💡 Если вы хотите расширить возможности бота, то используйте раздел “API”Там представлен токен, по которому можно подключить вашу программу к боту отправлять от его имени любые сообщения.Подробнее почитать про возможности API можно в нашем публичном API.


5. Настройте интеграцию в сервисе, который хотите подключить

Скопируйте Webhook URL из раздела “Входящие вебхуки” в настройках бота.

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

💡 Обычно такие инструкции висят на сайте сервисов в разделах “для разработчиков/for developers” или в похожих.

6. Добавьте созданную интеграцию в чат

1. Зайдите в настройки чата (серая иконка в правом верхнем углу чата)
2. Выберете “Интеграции”
3. Добавите созданную интеграцию

Обновлено 
9.5.2023