External Webhooks

Вебхук сообщает вашему приложению о событиях, которые происходят в пространстве Kaiten. Например, когда создали карточку, переместили ее на другую доску, добавили комментарий или списали время. Kaiten отправляет на указанный вами адрес POST-запрос с данными события в формате JSON, а ваш сервис обрабатывает их так, как нужно вам.

Вебхуки настраиваются отдельно для каждого пространства.

Установка вебхука

Настройка проходит в два шага:

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

Kaiten отправляет запросы только на адреса с доверенным SSL-сертификатом.

Доступ к разделу External Webhooks в настройках пространства по умолчанию есть у владельца аккаунта и пользователей с ролью администратора. Выдать доступ пользователям с другими ролями можно через настраиваемые роли.

Как создать вебхук

Откройте настройки пространства. Для этого наведите курсор на название пространства в левой панели и нажмите на появившуюся иконку шестеренки.
В открывшемся окне перейдите в раздел External Webhooks.
Создайте новый вебхук или откройте уже созданный.
Введите название и URL вебхука. В раздел «Фильтр событий» в строке «События» по умолчанию установлено «Все события». Нажмите на нее, чтобы выбрать нужные.

События в интерфейсе соответствуют событиям из документации.

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

В одном пространстве может работать сразу несколько вебхуков. Например, один отправляет события в вашу CRM, второй — в сервис аналитики.

Несколько вебхуков в одном пространстве доступны аккаунтам с модулем «Группы пользователей». Без модуля в пространстве работает один вебхук: его можно создать, включить и выключить.

Как изменить вебхук

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

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

Что приходит на ваш сервер

После установки активный вебхук будет срабатывать каждый раз, когда в пространстве происходит одно из поддерживаемых событий. На ваш адрес приходит POST-запрос с данными в формате JSON.

Структура проста и понятна:

создание объекта:

JavaScript
{
    "event": action,
    "data": {
      "author": {...},
      ... // model keys, see examples below
    },
}

изменение объекта:

JavaScript
{
    "event": action,
    "data": {
      "old": {...},
      "changes": {...},
      "author": {...}
    }
}

удаление объекта:

JavaScript
{
    "event": action,
    "data": {
      "author": {...},
      ... // model keys, see examples below
    }
}

На данный момент мы поддерживаем действия, принадлежащие пространствам, доскам, карточкам, блокам, комментариям, журналам времени, тегам, файлам.

👉 Подробнее об External Webhooks читайте здесь: https://developers.kaiten.ru/external-webhooks

Раздел External Webhooks в администрировании

Для аккаунтов с подключенным модулем «Группы пользователей» доступно управление вебхуками компании через административный раздел External Webhooks.

Подробнее о нем читайте в статье «External Webhooks: административный раздел»

Полезные ссылки

Didn't find the answer to your question?

Create a request — we'll help you out

Submit a request