Updating a trigger using an API request

Use this request to update a trigger.

Request formatRequest format

Before making a request, get permission to access the API.

To update a trigger, use an HTTP PATCH request. Request parameters are provided in the request body in JSON format.

PATCH /v2/queues/<queue_key_or_ID>/triggers/<trigger_id>?version=<trigger_current_version>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

{
    "name": "<trigger_name>",
    "actions": [<trigger_action_parameters>]
}

Examples:

1. Updating a trigger that fires if at least one of the conditions is met.
2. Updating a trigger that fires if all the conditions are met.
3. Updating a trigger that works when condition groups are met.
4. Disabling a trigger.
5. Moving a trigger in the list and activating it.

Example 1: Updating trigger conditions. The trigger must fire if at least one of the conditions is met.

• The HTTP PATCH method is used.
• The trigger for the DESIGN queue is being updated.
• The trigger ID is 16 and its current version is 1.
• The trigger condition is updated: the comment text matches the Need info phrase.
• Trigger action: the issue status changes to Need info.

PATCH /v2/queues/DESIGN/triggers/16?version=1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID: <organization ID>
{
  "actions": [
      {
          "type": "Transition",
          "status": {
              "key": "needInfo"
              }
      }
  ],
  "conditions": [
       {
           "type": "Or",
           "conditions": [
               { "type": "CommentFullyMatchCondition", "word": "Need info"},
               { "type": "CommentFullyMatchCondition", "word": "Need info"}
           ]
       }
   ]
}

Example 2: Updating trigger conditions. The trigger must fire if all the conditions are met.

• The HTTP PATCH method is used.
• The trigger for the DESIGN queue is being updated.
• The trigger ID is 16 and its current version is 2.
• The trigger condition is updated: the comment text matches the Need info phrase and the issue status is In progress.

PATCH /v2/queues/DESIGN/triggers/16?version=2
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-token>
X-Org-ID: <organization ID>
{
  "actions": [
      {
          "type": "Transition",
          "status": {
              "key": "needInfo"
              }
      }
  ],
}

Example 3: Changing trigger conditions and trigger action. Trigger must be activated when one of the condition groups is met.

• The HTTP PATCH method is used.
• The trigger for the DESIGN queue is being updated.
• The trigger ID is 16 and its current version is 2.
• The trigger condition is updated: Trigger is activated if one of the condition groups is met:
• • Comment text matches the Need info phrase and the issue status is In progress.
• • Comment text matches the No data phrase.
• Trigger action changes: the issue status changes to Need info.

PATCH /v2/queues/DESIGN/triggers/16?version=2
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth-token>
X-Org-ID: <organization ID>
{
  "actions": [
      {
          "type": "Transition",
          "status": {
              "key": "needInfo"
              }
      }
  ],
  "conditions": [
      {
          "conditions": [
              {
                  "conditions": [
                      {
                          "ignoreCase": false,
                          "noMatchBefore": false,
                          "removeMarkup": false,
                          "type": "CommentFullyMatchCondition",
                          "word": "Need info"
                      },
                      {     "type": "FieldEquals",
                            "field":"status",
                            "value":"inProgress"
                      }
                  ],
                  "type": "And"
              },
              {
                  "ignoreCase": false,
                  "noMatchBefore": false,
                  "removeMarkup": false,
                  "type": "CommentFullyMatchCondition",
                  "word": "No data"
              }
          ],
          "type": "Or"
      }
  ]
}

Example 4: Disabling a trigger.

• The HTTP PATCH method is used.
• The trigger for the DESIGN queue is being updated.
• The trigger ID is 16 and its current version is 3.
• The trigger is being deactivated.

PATCH /v2/queues/DESIGN/triggers/16?version=3
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID: <organization ID>
{
  "active": false,
}

Example 5: Moving a trigger in the list and activating it.

• The HTTP PATCH method is used.
• The trigger for the DESIGN queue is being updated.
• The trigger ID is 16 and its current version is 4.
• The trigger is being moved and placed before the trigger with the 6 ID and then activated.

PATCH /v2/queues/DESIGN/triggers/16?version=4
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID: <organization ID>
{
  "before": 6,
  "active": true,
}

Response formatResponse format

{
   "id": 16,
   "self": "https://https://api.tracker.yandex.net/v2/queues/DESIGN/triggers/16",
   "queue": {
      "self": "https://https://api.tracker.yandex.net/v2/queues/DESIGN",
      "id": "26",
      "key": "DESIGN",
      "display": "Design"
   },
   "name": "TriggerName",
   "order": "0.0002",
   "actions": [
      {
         "type": "Transition",
         "id": 2,
         "status": {
            "self": "https://https://api.tracker.yandex.net/v2/statuses/2",
            "id": "2",
            "key": "needInfo",
            "display": "Need info"
         }
      }
   ],
   "conditions": [
      {
         "type": "Or",
         "conditions": [
            {
               "type": "CommentFullyMatchCondition",
               "word": "Need info",
               "ignoreCase": true,
               "removeMarkup": true,
               "noMatchBefore": false
            },
            {
               "type": "CommentFullyMatchCondition",
               "word": "Need info",
               "ignoreCase": true,
               "removeMarkup": true,
               "noMatchBefore": false
            }
         ]
      }
      ],
      "version": 2,
      "active": true
   }