Listeners

Listeners are personalized Jira Webhooks. You can define as many listeners as you want under the Apps (Jira top menu) > Manage your apps > Easy Integrations configuration > Listeners app menu item.

List of Listeners

Listeners are displayed as list on the home page of Listeners. Click "Add listener" to create a new listener. Click listener name to update a listener.


Creating a new Listener


Field NameDescription
Listener NameGive a name for the listener, it's just a reminder for you!

Uncheck to disable the listener. 

Define how many times to retry when an API call is failed. Maximum 5 retries are allowed! Listener will try to continue where it was failed on previous attempt.
Events

Add events in the popup



Event kind

Select the type of the event:

  • JQL Supported
  • JQL not supported
EventsSelect one or more events to listen
JQL

Write the JQL for the "JQL Supported" event kind.

The JQL filter that specifies which issues the webhook is sent for. Only a subset of JQL clauses is supported. More information: https://developer.atlassian.com/cloud/jira/platform/webhooks/#supported-jql-queries .

Supported JQL queries

Only a subset of JQL clauses is supported. This enables us to optimize event matching on the Jira side.

Supported clauses (left-hand side values):

  • issueKey
  • project
  • issuetype
  • status
  • assignee
  • reporter
  • issue.property (any indexed issue property can be queried)
  • cf[id] (for custom fields – currently only the ID of the Epic custom field is supported here)

Supported operators: =, !=, IN, and NOT IN.

If you would like to use more clauses or operators, raise a request in the Atlassian Connect in Jira project or watch and comment on a relevant issue there.

When no event is selected! The listener will not work until it's selected in a Post Function of Easy Integrations app

Condition

Enable or Disable condition.

When enabled, write the JavaScript condition of the listener. When enabled, Listener actions will work if the script returns true.

See Context variables, Scripts and Events for details. Example:

return lodash.startsWith(data.event.issue.fields.summary, 'Sultans of Swing');
Actions

Add one or more actions for the listener. Each action is executed in order. A unique reference ID is assigned by the app for each action, example: "api3".

See Listener Actions for more details