Listeners

Owned by Tolga Tunca
Last updated: Oct 19, 2023 by Derya Özdemir
3 min read

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 or select a listener's name to update it.

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:

    • 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. 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 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 are -, !=, 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.

    • 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.

    • Actions: Add one or more actions for the listener, which will be executed in display order. To learn more about actions, click here.

  6. 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.