Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

...

Button handy
blankfalse
color#0052CC
nameCloud
linkhttps://appfire.atlassian.net/wiki/spaces/EIFJC/pages/10125437/Installation
width84
Button handy
blankfalse
color#EBECF0
nameOn-Prem
linkhttps://appfire.atlassian.net/wiki/spaces/EI4J/pages/11206868/Installation
width85

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#F4F5F7

This page is about Easy Integrations for Jira Cloud. Using Jira On-Prem? Click the On-Prem button above.

Listeners in Easy Integrations for Jira are personalized webhooks that enable you to define custom actions based on specific events in your Jira instance. You can create and manage multiple listeners to tailor your integration to meet your workflow needs.

All your listeners are conveniently listed on the homepage of Listeners. Here, you can click "Add listener" to create a new listener

...

Image Removed

Creating a new Listener

...

...

...

Add events in the popup

...

or select a listener's name to update it.

🎯 Index

Table of Contents
minLevel3
maxLevel6
outlinefalse
typelist
printablefalse
Image Added

How to Create a New Listener

To create a new listener, follow these steps:

  1. Navigate to Apps in the Jira top menu and select Manage your apps.

  2. In the sidebar, click Easy Integrations configuration.

  3. Choose Listeners from the top app menu.

  4. Click Add listener to create a new listener.

  5. When creating the listener, provide the following information:

    Image Added
    • Listener Name: Give your listener a descriptive name to help you identify it easily.

    • Listener is enabled: Check or uncheck to enable or disable the listener.

    • Retry attempt count: Define the number of retries for failed API calls (maximum 5 retries are allowed). The listener will attempt to continue where it previously failed.

    • Events: Add events for the listener by clicking Add event and selecting them from the popup.

      • Event kind: Select the type of the event:

...

      • JQL

...

      • supported or JQL not supported.

      • Events

...

      • : Select one or more events to listen

...

      • to. Without selected events, the listener won't function until added to a Post Function of the Easy Integrations app.

      • JQL: If you've selected the "JQL Supported" event

...

      • type, provide the JQL for it. The JQL filter

...

      • specifies which issues trigger the webhook

...

Supported JQL queries

...

      • . Note that only a subset of JQL clauses is supported. This enables us to optimize event matching on the Jira side.

...

      • For more information, check out this Jira article.
        The supported clauses (left-hand side values) are:

        • issueKey

        • project

        • issuetype

        • status

        • assignee

        • reporter

        • issue.property

...

        • (any

...

...

        • issue property can be queried.)

        • cf[id]

...

        • (for custom fields

...

        • - currently only the ID of the

...

        • Epic

...

        • custom field is supported here)

        Supported operators

...

      • are -,

...

      • !=,

...

      • IN, and

...

      • NOT IN.

...

      • If you would like to use more clauses or operators, raise a request in the

...

...

      • or watch and comment on a relevant issue there.

...

    • Condition

...

    • : Enable or

...

    • disable a condition.

...

    • When enabled, you must write the JavaScript condition

...

    • for the listener

...

    • , and the listener action will work if the script returns true.

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

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

...

    • Actions: Add one or more actions for the listener

...

    • , which will be executed in display order

...

  1. After you finish configuring your listener, click Save.

Troubleshooting

If you encounter issues with listeners, consider the following troubleshooting steps:

  • Ensure the listener is enabled.

  • Check the retry attempt count and adjust if needed.

  • Verify that events are correctly configured.

  • Double-check the JavaScript condition for the listener.

  • Review the actions and their order.

If the issue persists, get in touch with our Support team.