Создать триггер с помощью запроса к API

Запрос позволяет создать триггер.

POST

https://api.tracker.yandex.net/v3/queues/<id_очереди>/triggers

Формат запроса

Перед выполнением запроса получите доступ к API.

Чтобы создать триггер, используйте HTTP-запрос с методом POST. В теле запроса укажите параметры в формате JSON.

POST /v3/queues/<id_очереди>/triggers
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
    "name": "<имя_триггера>",
    "actions": [<параметры_действия_триггера>]
}
Заголовки
  • Host: адрес узла, предоставляющего API.

  • Authorization: токен для авторизации в одном из форматов:

    • OAuth <OAuth-токен> при авторизации по протоколу OAuth 2.0. Читать подробнее

    • Bearer <IAM-токен> при авторизации с помощью IAM-токена — если к Tracker привязана организация Yandex Cloud Organization. Читать подробнее

  • X-Org-ID или X-Cloud-Org-ID: идентификатор организации.

    • Используйте заголовок X-Org-ID, если к Tracker привязана организация Яндекс 360 для бизнеса.

    • Используйте заголовок X-Cloud-Org-ID, если к Tracker привязана организация Yandex Cloud Organization.

    Чтобы узнать идентификатор организации, перейдите на страницу АдминистрированиеОрганизации и скопируйте значение поля идентификатор.

Ресурс
Параметр Описание Тип данных
<id_очереди> Идентификатор или ключ очереди. Ключ очереди чувствителен к регистру символов. Строка или число
Параметры тела запроса

Обязательные параметры

Параметр Описание Тип данных
name Название тригера. Строка
actions Массив с действиями триггера. Массив объектов

Дополнительные параметры

Параметр Описание Тип данных
conditions Массив с условиями срабатывания триггера. Массив объектов
active Статус триггера. Допустимые значения:
  • true— активный;
  • false— неактивный.
Логический

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

  • Используется HTTP-метод POST.
  • Создается триггер для очереди DESIGN.
  • Условие срабатывания триггера: текст комментария совпадает с «Open».
  • Действие триггера: переход задачи в статус «Открыт».
POST /v3/queues/DESIGN/triggers
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>
{
  "name": "TriggerName",
  "actions": [
      {
          "type": "Transition",
          "status": {
              "key": "open"
              }
      }
  ],
  "conditions": [
       {
          "type": "CommentFullyMatchCondition",
          "word": "Open"
       }
   ]
}

Формат ответа

В случае успешного выполнения запроса API возвращает ответ с кодом 200 OK.

Тело запроса содержит информацию о созданном тригере в формате JSON.

{
"id": 16,
"self": "https://api.tracker.yandex.net/v3/queues/DESIGN/triggers/16",
"queue": {
    "self": "https://api.tracker.yandex.net/v3/queues/DESIGN",
    "id": "26",
    "key": "DESIGN",
    "display": "Дизайн"
},
"name": "trigger_name",
"order": "0.0002",
"actions": [
    {
        "type": "Transition",
        "id": 1,
        "status": {
            "self": "https://api.tracker.yandex.net/v3/statuses/2",
            "id": "2",
            "key": "needInfo",
            "display": "Требуется информация"
        }
    }
],
"conditions": [
    {
        "type": "Or",
        "conditions": [
            {
                "type": "Event.comment-create"
            }
        ]
    }
],
"version": 1,
"active": true
}


Параметры ответа
Параметр Описание Тип данных
id Идентификатор триггера. Строка
self Ссылка на триггер. Строка
queue Очередь, в которой нужно создать триггер. Может задаваться как объект, как строка (если передается ключ очереди), как число (если передается идентификатор очереди).
name Название триггера. Строка
order Вес триггера. Параметр влияет на порядок отображения триггера в интерфейсе. Строка
actions Массив с действиями триггера. Массив объектов
conditions Массив с условиями срабатывания триггера. Массив объектов
version Версия триггера. Каждое изменение триггера увеличивает номер версии. Число
active Статус триггера. Допустимые значения:
  • true— активный;
  • false— неактивный.
Логический

Поля объекта queue

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию об очереди. Строка
id Идентификатор очереди. Строка
key Ключ очереди. Строка
display Отображаемое название очереди. Строка

Поля объектов массива actions

Параметр Описание Тип данных
type Тип действия. Допустимые значения:
  • Transition— изменить статус задачи;
  • Update— изменить значения в полях;
  • Move— переместить задачу;
  • Event.comment-create— добавить комментарий;
  • CreateChecklist— создать чек-лист;
  • Webhook— отправить HTTP-запрос;
  • CalculateFormula— вычислить значение;
  • Event.create— создать задачу.
Строка
id Идентификатор действия. Строка
status Статус задачи. Строка

Поля объектов массива conditions

Параметр Описание Тип данных
type Тип условия. Допустипые значения:
  • or— логическое ИЛИ;
  • and— логическое И.
Строка
conditions Массив с условиями срабатывания триггера.
Условие имеет параметр type — тип условия. Допустипые значения:
  • CommentNoneMatchCondition— комментарий не содержит ни одного из фрагментов;
  • CommentStringNotMatchCondition— комментарий не содержит фрагмент;
  • CommentFullyMatchCondition— комментарий совпадает с;
  • CommentAnyMatchCondition— комментарий содержит любой из фрагментов;
  • CommentStringMatchCondition— комментарий содержит фрагмент;
  • CommentAuthorNot— автор комментария не;
  • CommentAuthor— автор комментария;
  • CommentMessageExternal— тип комментария Письмо на почту;
  • CommentMessageInternal— тип комментария Комментарий в Трекере.
Массив объектов

Поля объектов массива status

Параметр Описание Тип данных
self Адрес ресурса API, который содержит информацию о статусе. Строка
id Идентификатор статуса. Строка
key Ключ статуса. Строка
display Отображаемое название статуса. Строка

Если запрос не был успешно обработан, ответное сообщение содержит информацию о возникших ошибках:

400
Один или несколько параметров запроса имеют недопустимое значение.
403
У вас не хватает прав на выполнение этого действия. Наличие прав можно перепроверить в интерфейсе Tracker — для выполнения действия при помощи API и через интерфейс требуются одинаковые права.
404
Запрошенный объект не был найден. Возможно, вы указали неверное значение идентификатора или ключа объекта.
409
При редактировании объекта возник конфликт. Возможно, ошибка возникла из-за неправильно указанной версии изменений.
422
Ошибка валидации JSON, запрос отклонен.
500
Внутренняя ошибка сервиса. Попробуйте повторно отправить запрос через некоторое время.
503
Сервис API временно недоступен.