External Webhooks

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

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

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

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

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

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

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

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

Чтобы активировать вебхук в определенном пространстве, наведите курсор на название пространства в левой панели, нажмите на появившуюся иконку шестеренки и выберите раздел External Webhooks.

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

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

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

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

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

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

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

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

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

По умолчанию раздел доступен владельцу аккаунта и пользователям с доступом к разделу «Пользователи». Чтобы получить доступ, обратитесь к одному из них.

Подробнее о том, как выдать доступ, читайте в статье.

В разделе вы видите таблицу со всеми вебхуками компании: название, URL, пространства, к которым привязан вебхук, автора и статус активности.

В нем можно:

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

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

После установки активный вебхук будет срабатывать каждый раз, когда в пространстве происходит одно из поддерживаемых событий. На ваш адрес приходит 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

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

Didn't find the answer to your question?

Create a request — we'll help you out

Submit a request