Page Comparison

Create an event-based action

To create an event-based action:

1. Navigate to the Jira Settings → Apps → Event-based actionsClick on "New . This page lists the existing event-based action"

   1. Add a name and an optional description

   2. Define the event to listen to (see below)

   3. Define the scope of the action (see below)

   4. Add the post-functions to run when the action is triggered (see below)

2. Click on "Save"

Edit an event-based action

1. Click on “Edit” for the event-based action

2. Modify the action details

3. Click on “Save”

Delete an event-based action

1. Click on “Delete” for the event-based action

2. Click on “OK”

3. The event-based action is deleted.

Enable/disable an event-based action

1. Click on “Disable” if the event-based action is currently enabled, or “Enable” if the event-based action is currently disabled

2. Click on “OK”

3. The event-based action is enabled or disabled.

Event to listen to

Configure which Jira event should trigger this Action. You can listen to the following events:

1. actions with the respective Status, Action name, and Event(s) details.
   

   Image Added

2. Click New event-based action to navigate to the Event-based Action Editor screen where you can configure the following details:
   

   Image Added

   • Name (mandatory): Enter a meaningful name.

   • Description: Enter a more detailed explanation of what the action would accomplish.

   • Event: Select the Jira event that triggers the action from the following:
     Trigger (mandatory):

     • Issue Created (default option): Triggered when a new issue is created, including when an issue is cloned.

     • Issue Updated:

1. • • Triggered when an issue is modified, such as being edited or transitioned.

     • Issue Deleted: Triggered when an issue is deleted.

     • Issue Commented:

1. • • Triggered when a comment is added to an issue.

     • Issue Transitioned:

1. • • Triggered when a transition is performed on an issue. You can optionally filter the source and/or destination statuses of the transition.

     • Issue Field Value Change:

1. • • Triggered when one of the fields you have selected is modified on an issue

Ignoring app-related events

1. • • .

     • Attachment Created: Triggered when an attachment is added to an issue.

     • Attachment Deleted: Triggered when an attachment is deleted from the issue.

     • Issue Link Added: Triggered when an issue link is added to an issue.

     • Issue Link Deleted: Triggered when an issue link is deleted to an issue.

     • Work Log created: Triggered when a worklog entry is added to the issue.

     • Work Log updated: Triggered when a worklog entry is updated on the issue.

     • Work Log deleted: Triggered whenever a worklog entry is deleted from the issue.

   • Ignore events caused by JMWE post-functions and actions: Select this option to ignore events resulting from changes performed by JMWE post-functions and

1. • actions that trigger this event-based action. If you do not select this option, it increases the risk of creating an infinite loop if this event-based action makes changes that end up triggering the same event that the action listens to.

   • Ignore events caused by Jira Automation and other apps: Select this option to ignore events resulting from changes performed by Jira Automation rules, or by other apps. For example, if you have configured an event-based action to listen to the Issue

1. • Transitioned event, you might care only about comments created by users, and want to ignore

1. • transitions performed by an Automation rule.

To ignore events caused by JMWE post-functions and actions, check the Ignore events caused by JMWE post-functions and actions checkbox.

Likewise, you can choose to ignore events resulting from changes performed by a Jira Automation rule or by another app. For that, check the Ignore events caused by Jira Automation and other apps checkbox.

Scope

Filtering by project and issue type

You can choose to apply an event-based action only to certain projects and/or issue types. This will usually result in better performance.

To apply the event-based action only to certain projects, select one or more projects under Projects. If you don’t select any project, the event-based action will apply to issues from all projects.

To apply the event-based action only to certain issue types, select one or more issue types under Issue types. If you don’t select any issue type, the event-based action will apply to issues of all types.

Filtering using a JQL expression

1. • Scope: Specify the project(s) and issue type(s) on which the action is run. You can further choose to apply the action on the issues that match a JQL filter or Nunjucks condition.

     • Projects: Select one or more projects from the available options for the action to be applied on. When you leave this field empty, the action is applied to all the projects in your Jira instance.

     • Issue types: Select one or more issue types from the available options for the action to be applied on. When you leave this field empty, the action is applied to all the issue types in your Jira instance.

     • Only apply to issues that match a JQL filter

1. • • : Select this option to apply the action on issues that match

1. • • a JQL filter.

1. • • Click Edit JQL to search

1. Check the “Only apply to issues that match a JQL filter” checkbox

2. Click on "Edit JQL"

3. Input a JQL expression that will return the issues on which the action should be run. See here to know how to write a JQL. For example

4. Check the “Only apply to issues that match a Nunjucks condition” checkbox

5. Input a Nunjucks template that will return

   • • for issues using a JQL filter in the JQL editor window and click Submit.
       Example:

       Code Block
       language sql
       project = TEST and issuetype = Bug

6. Click on "Search" to check the issues returned by the JQL. It is recommended to check the results of the JQL to avoid invalid JQL.

7. Click on "Submit"

Filtering using a Nunjucks condition

You can choose to apply an event-based action only to issues that match a Nunjucks condition. The action will only run on issues for which the Nunjucks template returns true (or any value that is neither empty nor false).

1. • • Only apply to issues that match a Nunjucks condition: Select this option to apply the action on issues that match the Nunjucks condition mentioned in:
       Nunjucks condition: Enter a Nunjucks template that returns true (or any value that is neither empty nor false) for any issue on which the action should run.

   For example

   • • 
       Example:

       Code Block
       language sql
       {{ issue.fields.project.key == "TEST" and issue.fields.issuetype.name == "Bug" }}

       Click here to understand how to pass variables within a sequence.

   • Post-functions

Whenever the event is triggered by Jira, and if the issue belongs to the Scope defined above, the configured post-functions will be run, in the order in which they appear. You can reorder the post-functions by dragging them using the ☰ handle.

Add a post-function in an action

1. Click on “Add post-function”

2. Select the post-function

3. Configure the post-function

4. Click on “Save”

Edit a post-function in an action

1. Click on “Edit” for the specific post-function

2. Modify the post-function

3. Click on “Save”

Reorder the post-function sequence in an action

1. Drag the ☰ handle and reorder the post-functions

Remove a post-function in an action

1. Click on “Remove” for the specific post-function

1. • : Click Add post-function to navigate to the window that lists all the available post-functions. Select a post-function, configure it as needed and add it to the list here. The post-functions added here are run in the sequence displayed. You can use the ☰ handle to drag a post-function and drop it wherever required in the list to reorder the sequence.

   • Error handling
     Skip subsequent post-functions if a post-function encounters an error: Select this option to skip running the remaining post functions in the sequence when an error occurs in one of the post functions.

2. Click Save to add the newly created event-based action to the Event-based action screen.

Edit an event-based action

1. Click Edit in the Event-based actions screen to modify the respective event-based action.

2. Modify the action details in the Event-based Action Editor screen.

3. Click Save to save the changes.

Delete an event-based action

1. Click Delete in the Event-based actions screen to remove the respective event-based action permanently.

2. Click OK in the confirmation dialog to confirm. The event-based action is deleted.

Enable/disable an event-based action

In the Event-based actions screen, turn the toggle Off or On in the Enable column to disable or enable the respective event-based action. By default, a newly created event-based action is enabled.

Pass variables within a sequence

Using the {% setContextVar %} Nunjucks tag you can pass data from one post-function to all subsequent post-functions.

• context: Holds all the context variables added in the current post-function. For example, if you create a context variable myVar in the first post-function of the sequence:

  Code Block
  language js
  {% setContextVar myVar = "a value" %}

  This variable will then be available to all its subsequent post-functions as:

  Code Block
  language js
  {{ context.myVar }}

   Note

Variables specific to the Create Issue post-function

• newIssueKey: Stores the issue key of the last issue created by a Create Issue(s) post-function in the action. You can access it as:

  Code Block
  language js
  {{ context.newIssueKey }}

• newIssueKeys: Stores an array of the keys of all the issues created by any Create Issue(s) post-function in the action. You can access the created issues from

  Code Block
  language js
  {{ context.newIssueKeys }}

  For example: to add a comment on the current issue with the keys of the issue created

  Code Block
  language js
  Issues created are: {{ context.newIssueKeys | join(",") }}

You can access the information of a specific issue using the issue filter. For example: To get the assignee of the issue created by the Create Issue post-function

{{ context.newIssueKey | issue("assignee") | field("fields.assignee.displayName") }}

Error handling