Trigger action objects

To manage trigger actions, specify one or more objects.

Changing issue status

Parameter Description Acceptable values Data type
type Action type Transition String
status Issue status Status key, ID, or name String

Example: Change the issue status to "In progress".

{ "type": "Transition", "status": "In progress" }

Calculating a value

Parameter Description Acceptable values Data type
type Action type CalculateFormula String
formula Formula Math expression String
resultField Field the value is calculated in Field key or name String

Example: Calculate the date three months from today and add the resulting value to the "Start" field.

{ "type": "CalculateFormula", "formula": "now()+3M", "resultField": "start" }

Updating fields

Parameter Description Acceptable values Data type
type Action type Update String
update Object with a list of issue fields that you want to change. Full list of issue fields The "field key – value" pair.

To clear the field, specify the null value.
You can also use the set, add, and remove operators (see Editing parameters)
Object

Example: Change issue field values.

  • Change the issue description to "New issue".
  • Add the "New tag" tag.
  • Clear the "Resolution" field.
{
   "type": "Update",
   "update": {
       "description": "New issue",
       "tags": { "add": "New tag" },
       "resolution": null
   }
}

Moving an issue

Parameter Description Acceptable values Data type
type Action type Move String
queue Queue Queue key String

Example: Move the issue to "TESTQUEUE".

{ "type": "Move", "queue": "TESTQUEUE"}

Adding a comment

Parameter Description Acceptable values Data type
type Action type CreateComment String
text Text of the comment Text String
fromRobot Send on behalf of the robot or on behalf of the user who activated the trigger.
  • true: Send on behalf of the robot.
  • false: Send on behalf of the user who activated a trigger.
Boolean

Example: Send a comment on behalf of the user who activated a trigger. Comment: Request created on <current_date>.

{ "type": "CreateComment", "text": "Request created on {{currentDateTime.date}}", "fromRobot": false }

Create a checklist

Parameter Description Acceptable values Data type
type Action type CreateChecklist String
checklistItems List of checklist items Array of objects with the following fields:
  • text: Issue description (required field)
  • assignee: Issue assignee
  • deadline: Deadline in {"date": "YYYY-MM-DD"} object format.
Array of objects

Example: Create a checklist with three items.

  • Item 1: "Do this".
  • Item 2: "Do that".
  • Item 3: "Report the results".

Set the same deadline (October 26, 2025) and assignee (the user with login @username) for the first two items. For the last item, set only the title.

{
   "type": "CreateChecklist",
   "checklistItems": [
         {
            "text": "Do this",
            "assignee": "username",
            "deadline": {"date": "2025-05-23"}
         },
         {
            "text": "Do that",
            "assignee": "username",
            "deadline": {"date": "2025-05-23"}
         },
         {   "text": "Report the results"}
   ]
}

HTTP request

Parameter Description Acceptable values Data type
type Action type Webhook String
endpoint Address Request URL String
authContext Authorization method Object with authorization data String
method Request method Possible values:
  • GET
  • POST
  • PUT
  • DELETE
String
contentType Type of content application/json String
headers Headers Object with fields in key-value format Map item
body Request body Object with data or string Object or String

Acceptable authorization objects

Authorization type Map item
NoAuth { "type": "noauth" }
Basic { "password": "********", "type": "basic", "login": "<username>" }
OAuth 2 { "headerName": "Authorization", "type": "oauth", "accessToken": "********", "tokenType": "Bearer"}

Example: Execute an HTTP request using the GET method.

  • Request URL: https://api.example.com/messenger/sendMessage.
  • Content type: application/json; charset=UTF-8.
  • Authorization type: "Basic".
  • In the request header, pass the ru-RU value for the Content-Language parameter.
  • In the request body, pass a message with the text "Success".
{
   "type": "Webhook",
   "endpoint": "https://api.example.com/messenger/sendMessage",
   "method": "GET",
   "contentType": "application/json; charset=UTF-8",
   "headers": { "Content-Language": "ru-RU" },
   "authContext": { "password": "********", "type": "basic", "login": "user1" },
   "body": {"message":"Success"}
}

Creating an issue

Parameter Description Acceptable values Data type
type Action type CreateIssue String
queue Queue Queue key String
summary Name Text String
fieldTemplates Issue parameters Object with the issue parameters Map object
linkWithInitialIssue Link it to the issue that activated the trigger
  • true: Link.
  • false: Do not link.
Boolean
fromRobot Create issues as a robot Object with issue fields
  • true: Create on behalf of the robot.
  • false: Create on behalf of the user who fired a trigger.

Parameters of objects with issue fields

Parameter Description Acceptable values Data type
followers Followers Array with user IDs Array of strings
dueDate Deadline Date String
description Description Text String
assignee Assignee User ID String
priority Priority Priority key or name String
type Issue type Type key or name String
tags Tag list Array of string elements Array of strings

Example: In "TESTQUEUE", create an issue titled "New issue" on behalf of the robot.

  • Followers: Users with logins @user1 and @user2.
  • Assignee: User with login @user3.
  • Deadline: October 31, 2024.
  • Description: Created by the trigger <current_date>.
  • Priority: "Critical".
  • Type: "Milestone".
  • Tags: new task and by trigger.
{
   "type": "CreateIssue",
   "queue": "TESTQUEUE",
   "summary": "New issue",
   "fieldTemplates": {
         "followers": ["user1", "user2"],
         "assignee": "user3",
         "dueDate": "2024-10-31",
         "description": "Created by the trigger {{currentDateTime.date}}",
         "priority": "critical",
         "type": "milestone",
         "tags": ["new task", "by trigger"]
   },
   "fromRobot": true
}