Релизы

API: Получение списка наблюдателей. Добавление и удаление наблюдателей

ГлавнаяБлогРелизы
Share

API: Управление наблюдателями задачи

В Neaktor появился новый функционал API: Получение списка наблюдателей. Добавление и удаление наблюдателей

ℹ️  Наблюдатель — это пользователь, который следит за задачей: получает уведомления обо всех изменениях, может просматривать содержимое и оставлять комментарии, не являясь исполнителем.

Шаг 1. Создайте робота или автодействие

Управление наблюдателями удобнее всего настраивать через встроенный механизм автодействий Neaktor. Есть два способа:

Способ А: через робота

В разделе «Тогда» выберите «Выполнить автодействие» → «Отправить запрос».

Способ Б: через схему бизнес-процесса

Добавьте в схему блок «Автодействие» и выберите тип «Отправить запрос».

💡  Оба способа ведут к одному и тому же результату — выбирайте тот, который удобнее для вашего процесса.

Шаг 2. Получите API-ключ

Для авторизации запросов вам понадобится публичный API-ключ с правами на чтение и запись. Чтобы его создать:

  1. Перейдите в модуль «Интеграции» → «API ключи».
  2. Нажмите «Сгенерировать новый ключ».
  3. В настройках ключа: тип — «Публичный ключ», статус — измените с «Только чтение» на «Чтение и запись».
  4. Скопируйте сгенерированный ключ — он понадобится в следующих шагах.

⚠️  Публичный ключ передаётся в заголовке запроса Authorization. Не передавайте ключ третьим лицам — он даёт доступ к данным вашего аккаунта.

Получение списка наблюдателей

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

URL:  https://api.neaktor.com/v1/tasks/{taskId}/watchers 

Тип запроса: GET

Укажите в заголовке запроса:

  • Заголовок:  Authorization   Значение: ваш публичный ключ

Пример запроса

curl -X GET \

     https://api.neaktor.com/v1/tasks/126631161/watchers \

     -H ‘Authorization: ВАШ_ПУБЛИЧНЫЙ_КЛЮЧ’

💡   Идентификатор задачи (taskId) — это числовой ID, который виден в адресной строке браузера когда вы открываете задачу.

Добавление наблюдателей

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

URL:  https://api.neaktor.com/v1/tasks/{taskId}/watchers 

Тип запроса: POST

Content-Type:  json 

Укажите в заголовке запроса:

  • Заголовок:  Authorization   Значение: ваш публичный ключ

Тело запроса

В тело запроса передайте массив числовых идентификаторов пользователей:

{

     «users»: [

       1640705,

       1516805

     ]

}

Удаление наблюдателей

Чтобы убрать пользователей из наблюдателей, используется тот же URL, что и при добавлении. Единственное отличие — тип запроса меняется с POST на DELETE:

URL:  https://api.neaktor.com/v1/tasks/{taskId}/watchers 

Тип запроса: DELETE

Content-Type:  json 

Тело запроса

Тело запроса идентично добавлению — передайте массив ID пользователей, которых нужно удалить:

{

     «users»: [

       1640705,

       1516805

     ]

}

Итог

Управление наблюдателями через API открывает удобные возможности для автоматизации бизнес-процессов:

  • автоматически добавляйте коллег в наблюдатели при создании задачи или смене этапа
  • убирайте пользователей из наблюдателей когда их участие в задаче завершилось
  • управляйте наблюдателями из внешних систем через REST API

Все три операции работают на одном URL — тип HTTP-метода определяет действие: GET — просмотр, POST — добавление, DELETE — удаление.

✉️  Если у вас остались вопросы — напишите нам на help@neaktor.com или оставьте комментарий ниже.

;

Оставьте комментарий