Интегрируйте AirFocus с веб-хуками.

Преимущества использования веб-хуков

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

Первоначальная настройка нового веб-хука.

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

Требования:

• Полные права доступа к рабочей области, в которой вы хотите настроить веб-перехватчик.
• Платная подписка на план «Профессиональный» или «Корпоративный».
• Технические знания для правильной настройки.

Вы можете добавить несколько веб-хуков в заданное рабочее пространство (например, в разные каналы Slack для разных аудиторий заинтересованных сторон).

Для этого просто перейдите в раздел «Расширения» в вашей рабочей области, нажмите «Добавить интеграцию» и «Подключить» в разделе «Веб-перехватчик».

Далее, дайте своему веб-хуку имя (необязательно) и выберите события, при которых должны запускаться запросы.

В параметрах запроса выберите формат заполнителя и метод, а затем вставьте URL-адрес вашего веб-перехватчика в поле URL. При необходимости вы также можете добавлять заголовки к своим запросам.

При желании вы также можете настроить тело запроса в формате заполнителя, выбранном выше.

{
 "блоки": [
 {
     "type": "divider"
   },
 {
 "тип": "раздел",
 "текст": {
 "type": "mrkdwn",
 "текст {{title|esc}}"
 },
 "аксессуар": {
 "тип": "кнопка",
 "текст": {
         "type": "plain_text",
         "text": "Open in airfocus",
         "emoji": true
       },
 "value": "click_me_123",
 "url": "{{url}}",
 "action_id": "button-action"
 }
 },
 {
 "тип": "раздел",
 "текст": {
 "type": "mrkdwn",
 "текст": "{{details|esc}}"
 }
 }
 ]
}

Подробную информацию о параметрах настройки веб-хуков см. в следующем разделе.

Пример использования — получение уведомлений в Slack об обновлениях airfocus.

В данном случае наша цель — настроить веб-перехватчик, который будет отправлять сообщение Slack в выбранный нами канал каждый раз, когда обновляется статус объекта в рабочей области, для которой мы настроили веб-перехватчик.

Для этого нам нужно настроить приложение Slack для генерации URL-адреса веб-перехватчика, а затем настроить остальную часть интеграции в AirFocus.

Как создать URL-адрес веб-перехватчика для вашего канала Slack:

1. Создайте новое приложение Slack в рабочем пространстве Slack, куда вы хотите получать уведомления от airfocus.
   
   
2. На странице «Функции» включите опцию «Активировать входящие веб-перехватчики» .
   
3. Нажмите «Добавить новый веб-перехватчик в рабочую область».
   
4. Выберите канал, в который приложение будет публиковать сообщения, затем нажмите «Разрешить».
   
5. Скопируйте URL-адрес веб-перехватчика и откройте рабочую область AirFocus, для которой вы хотите настроить обновления.
   

Как настроить веб-хук в AirFocus для отправки уведомлений об обновлении событий в Slack:

1. В всплывающем окне расширений нажмите «Добавить интеграцию».
   
2. В обзоре интеграции нажмите «Подключиться» под интеграцией «Веб-перехватчики».
   
3. Присвойте вашему веб-хуку имя (необязательно) и выберите события, при которых должны запускаться запросы. → Для данного варианта использования статус «Обновлен».
   
4. В параметрах запроса выберите «Slack markdown» в качестве формата-заполнителя и «POST» в качестве метода. Теперь вставьте скопированный из Slack URL-адрес веб-перехватчика в поле URL.
   
5. Чтобы получать сообщения Slack в правильном формате, вставьте следующий шаблон в поле "Тело" и нажмите "Обновить".

   •  

     {
      "блоки": [
      {
          "type": "divider"
        },
      {
      "тип": "раздел",
      "текст": {
      "type": "mrkdwn",
      "текст {{title|esc}}"
      },
      "аксессуар": {
      "тип": "кнопка",
      "текст": {
              "type": "plain_text",
              "text": "Open in airfocus",
              "emoji": true
            },
      "value": "click_me_123",
      "url": "{{url}}",
      "action_id": "button-action"
      }
      },
      {
      "тип": "раздел",
      "текст": {
      "type": "mrkdwn",
      "текст": "{{details|esc}}"
      }
      }
      ]
     }

      

6. Теперь вы будете получать сообщение Slack на выбранный вами канал при изменении статуса любого объекта в рабочей области.
   

Получайте обновления airfocus в Microsoft Teams

Функция «Рабочие процессы» Microsoft Teams позволяет настроить веб-перехватчик, который отправляет сообщение Teams в указанный канал при обновлении объектов в конкретном рабочем пространстве airfocus . Для этого вам потребуется сгенерировать URL-адрес веб-перехватчика в Microsoft Teams, а затем настроить остальную часть интеграции в airfocus.

Создайте URL-адрес веб-перехватчика в Microsoft Teams.

Чтобы сгенерировать URL-адрес веб-перехватчика в Microsoft Teams, выполните следующие действия:

1. Войдите в Microsoft Teams.
2. Нажмите на значок меню с тремя точками в навигационном меню в крайнем левом углу.
3. Select workflow.
4. В строке поиска введите «webhook».
5. Выберите опцию «Отправлять сообщения в канал при получении запроса веб-перехватчика».
6. Введите название для вашего workflow (например, "обновления AirFocus").
7. Нажмите «Далее».
8. В разделе «Подробности» выберите конкретную команду и канал, где вы хотите, чтобы отображались обновления.
9. Нажмите «Добавить workflow.
10. На экране подтверждения скопируйте URL-адрес POST-запроса.
    • Это URL-адрес веб-перехватчика, который вам нужно будет вставить в airfocus.
11. Нажмите «Готово» , чтобы завершить настройку.

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

Чтобы настроить веб-перехватчик в airfocus, выполните следующие действия:

1. Откройте рабочую область airfocus, для которой вы хотите отправлять обновления в Microsoft Teams.
2. Нажмите «Расширения» в правом верхнем углу рабочей области.
3. Выберите «Добавить интеграции».
4. В разделе «Веб-перехватчики» нажмите «Подключить ».
5. Введите имя для веб-перехватчика.
6. В разделе «События» выберите типы обновлений, которые вы хотите отправлять в Microsoft Teams.
7. В разделе «Формат заполнителя» выберите Markdown.
8. В разделе «Метод» выберите POST , затем вставьте URL-адрес, сгенерированный в Microsoft Teams, в поле «URL».
9. Выбрать + Добавить заголовок.
10. В поле «Название заголовка» введите «Content-Type».
11. В поле «Значение заголовка» введите «application/json».
    
12. Чтобы получать сообщения Microsoft Teams в корректном формате, вставьте следующий шаблон в поле "Тело сообщения".

    • {
       "type": "AdaptiveCard",
       "$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
       "версия": "1.4",
        "тело": [
       {
       "type": "TextBlock",
       "текст": "{{title}}",
       "размер": "Средний",
       "вес": "Более",
       "wrap": true
       },
       {
       "type": "TextBlock",
       "текст {{details}}",
       "wrap": true
       }
       ],
       "действия": [
       {
       "type": "Action.OpenUrl",
       "title": "Открыть в airfocus",
       "url": "{{url}}"
       }
       ]
       }

13. Нажмите кнопку «Обновить» в правом нижнем углу страницы.

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

Настройка HTTP-запросов — техническая документация

Метод

По умолчанию установлен тип запроса POST, но его можно изменить на GET или PUT. Другие методы не поддерживаются.

URL-адрес

• не должен быть пустым
• Начинается только с https:// (другие схемы или пустая схема не поддерживаются)
• Должно быть общедоступное доменное имя с хорошо известным доменом верхнего уровня (IP-адреса не поддерживаются).

Заголовки

• Авторизация поддерживается.
• Content-Type поддерживается.
• Поддерживаются пользовательские заголовки, начинающиеся с x-.
• Любые другие заголовки не поддерживаются.

Основной текст

Определяет тело запроса веб-перехватчика.

Может содержать любой текст длиной до 2000 символов.

Для того чтобы заполнить тело запроса осмысленными данными о событии, мы предоставляем набор заполнителей, которые наш сервер заменяет данными о событии перед отправкой запроса.

Формат-заполнитель

Указывает, как наш сервер должен предварительно отображать заполнители с типом RichText. Например, заполнитель {{title}} может содержать строку типа « John updated field Labels on object Fix the button », которая включает в себя форматирование текста, например, жирный шрифт, курсив и т. д., и, следовательно, формат заполнителя указывает, в каком именно синтаксисе следует преобразовать это форматирование. Доступные форматы:

Заполнители

Модели данных

Модель полезной нагрузки события

Объект верхнего уровня, создаваемый для каждого мероприятия. Он содержит данные о событии, а также встроенную базовую информацию обо всех событиях, связанных с этим событием.

Модель событий

Основные сведения о мероприятии

Модель инициатора события

Информация о том, кто инициировал это событие. В большинстве случаев идентификатор пользователя будет определен. Также возможно, что будут определены и userId, и integrationId — например, если пользователь нажал кнопку «синхронизировать интеграцию», что привело к возникновению события.

Модель EventEmbed

Дополнительная информация о событии — в основном названия объектов/рабочих областей/полей и т. д., связанных с этим событием.

Модель TeamInfo

Модель UserInfo

Модель AppInfo

Модель WorkspaceInfo

Модель IntegrationInfo

Модель StatusInfo

Модель ItemInfo

Модель EventData

EventData — это объединяющий тип, то есть он может быть любого из указанных типов:

CreatedItem

Обновленный элемент

Оставьте отзыв об этой статье