Skip to end of banner
Go to start of banner

Listeners

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Current »

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 allow you to define custom actions based on specific events in your Jira instance. You can create and manage multiple listeners to tailor your integration according to your workflow needs.

All of your listeners are displayed as a list on the home page of Listeners. Here you can click “Add listener” to create a new listener, or click the listener’s name to update it.

🎯 Index

How to Create a New Listener

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

  2. From the sidebar, click Easy Integrations configuration.

  3. Choose Listeners from the top app menu.

  4. Click Add listener to create a new listener.

  5. Fill in the required details:

    • Listener Name: Provide a descriptive name for the listener. This is just a reminder for you.

    • 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 try to continue where it failed on the previous attempt.

    • 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. When no event is selected, the listener will not work until it's selected in a Post Function of Easy Integrations app.

      • JQL: If you selected the “JQL Supported” event type, write the JQL for it. The JQL filter specifies which issues the webhook is sent for. Only a subset of JQL clauses is supported. For more information, check out this Jira article. Only a subset of JQL clauses is supported. This enables us to optimize event matching on the Jira side. 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 of 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.

  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.

  • No labels