External Webhooks

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

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

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

Создание вебхука — это процесс из двух шагов:

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

2. а затем нужно настроить ваш сервер для приема и управления данными.

Чтобы активировать вебхук в определенном пространстве в Kaiten, перейдите в настройки пространства, выберите «External Webhooks» в меню и введите ваш URL, который будет получать POST-запросы вебхука. Для регистрации вебхука нажмите создать. По умолчанию новый вебхук сразу будет активен, но вы всегда можете выключить его в меню.

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

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

• добавить события

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

• обновить события

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

• удалить события

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

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

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