Добавление бота в Chatwork

Особенности работы с Chatwork

• Для 1 воркспейса заводится 1 аккаунт бота. Аккаунт бота – это технический пользователь, которого нужно добавить в канал так же как обычных людей
• Для сдачи и редактирования стендапа создаются отдельные вебхуки в аккаунте бота.
• Есть 2 вида вебхуков: Account и Room.
  • Account → глобальный вебхук для всего воркспейса. Отвечает за принятие стендапов. Его нужно создать 1 раз
  • Room → локальный вебхук для отдельного канала. Отвечает за обновление стендапов. Его нужно создавать по отдельности для каждого канала
• В связи с тем, что в 1 воркспейс создается 1 аккаунт бота, все вебхуки по воркспейсу хранятся в одном месте. Точнее, если в воркспейсе несколько проектов, то вебхуки по всем проектам будут в одном аккаунте бота.

Создание Chatwork-канала

Если у вас еще нет канала в Chatwork, нужно создать его:

1. Создать канал
2. Настроить имя канала, добавить участников, указать их полномочия, установить допуск к каналу по разрешению админа (если необходимо)

Регистрация Chatwork-канала в Enji

1. Сперва нужно узнать имя и ID вашего канала
2. Перейти в Enji на страницу Team channels. Создать новый канал и ввести в него данные вашего Chatwork-канала

Регистрация Chatwork-аккаунта в Enji

1. Сперва нужно узнать ID и имя вашего Chatwork-аккаунта:
   1. В Chatwork перейти в настройки вашего аккаунта, открыть Preferences (скриншот 1a)
   2. Нужно скопировать ID вашего Chatwork-аккаунта (скриншот 1b)
   3. Далее закрыть Preferences и зайти в профиль вашего Chatwork-аккаунта. Скопировать имя аккаунта (скриншот 1с)
2. Перейти в Enji на страницу Messenger Accounts. Создать нового пользователя и ввести данные вашего Chatwork-аккаунта

Связка Chatwork-канала и Enji-проекта

Перейти в настройки вашего Enji-проекта (которые можно найти на странице Projects) и привязать к нему ваш Chatwork-канал

Добавление enji-бота в Chatwork-канал

1. Зайти в Chatwork, перейти в настройки вашего канала. Скопировать ссылку на ваш Chatwork-канал
2. В новом окне браузера авторизоваться в Chatwork-аккаунт enji-бота
   1. Авторизовавшись за enji-бота, перейти по инвайт-ссылке на ваш Chatwork-канал (скриншот 2a)
   2. Присоединиться к каналу (скриншот 2b)

Настройка веб-хуков enji-бота

Для настройки веб-хуков необходимо:

1. Перейти в Integrations
2. Открыть вкладку Webhook
3. Есть 2 вида вебхуков: Account и Room.
   1. Account event -> глобальный вебхук для всего воркспейса. Отвечает за принятие стендапов (т.е. message created). Его нужно создать 1 раз
   2. Room event -> локальный вебхук для отдельного канала. Отвечает за обновление стендапов (т.е. message updated). Его нужно создавать по отдельности для каждого канала
   В связи с тем, что в 1 воркспейсе создается 1 аккаунт бота, вебхуки по всем проектам воркспейса хранятся в одном месте.
4. Если вебхука Account event нет, нужно создать новый:
   1. Нажать Create New
   2. Откроется новая страница (скриншот 4). Необходимо ввести:
      1. имя веб-хука (описание того, что он делает),
      2. его URL (как пример, https://chatwork-bot.staging.enji.ai/register_standup) – запросите актуальный URL у вашего менеджера,
      3. выбрать Account event
      4. нажать на кнопку create
5. Создать новый вебхук Room event для своего канала:
   1. Нажать Create New
   2. Откроется новая страница (скриншот 5). Здесь необходимо ввести:
      1. имя веб-хука (описание того, что он делает),
      2. его URL – запросите актуальный URL у вашего менеджера,
      3. выбрать Room event,
      4. нажать на чекбокс Message updated,
      5. ввести ID вашего канала
      6. нажать на кнопку create

После этого, бот готов принимать, отслеживать и реагировать на стендапы от участников вашего канала, зарегистрированных в Enji. Регистрировать участников нужно, следуя инструкции из раздела “Регистрация Chatwork-аккаунта в Enji“

Процесс сдачи стендапов

Создание и сдача стендапа

1. Добавить enji-бота в список своих контактов
2. Указать бота в качестве адресата вашего сообщения (стендапа)
3. Написать о том что вы делали вчера, что планируете делать сегодня и сообщите о проблемах/хороших вещах. Пример стендапа – скриншот 3
4. Стендап считаетсяпринятым, когда бот отправляет вам личное сообщение с текстом Thanks for the standup!

Если бот не прислал вам сообщение или уведомил об ошибке, свяжитесь с вашим менеджером

Редактирование стендапа

Вы можете внести изменения в отправленный стендап. Для этого нужно:

1. Навести курсор на ваш стендап и нажать на кнопку Edit
2. Внести необходимые изменения и сохранить их
3. Бот должен прислать вам личное сообщение с текстом Standup has been updated.

Если бот не прислал вам сообщение или уведомил об ошибке, свяжитесь с вашим менеджером