Event Listeners

The event-listener feature allows you to listen and react to events originating from external services/apps.

To create a new event listener, you can click on the + next to the Event Listeners category in the resource tree. When you do, you'll be asked to select the app (service) you want to start listening for events from. After confirming which app you would like to work with, you're taken to a screen and asked for the following information:

• Event Type
  You must select which event type you want to listen to. Event types are specific to the app you have chosen.
• Linked Script
  You'll have the option to either create a new script event listener setup by specifying a name for the new script or link an existing one. We recommend creating a new script because it will be generated with the appropriate TypeScript event type you selected. If you link an existing script, then it's up to you to ensure that the TypeScript's event type is correct. If the type is incorrect, the editor will display incorrect suggestions.
• Connector
  (Global) connector to link with the event listener. Most of the time, this is not mandatory. Still, we recommend doing it anyway because it logically relates the incoming event listener to a (global) connector, which can help increase the visibility of how connectors are being used. Most of the time, we'll provide more detailed setup instructions if the connector is linked.

After you save the event listener for the first time, you will receive final setup instructions, which basically ask you to register a webhook in the external service/app.

You don't have to set up the event listener right away, but you can always return to it and click View setup instructions to finish the setup.

Environments

When you create a new environment, you'll be asked to relink the connector and re-run the setup instructions (if required) to register the event listener within the context of your new environment.

Test event payloads

Testing your script by triggering event listeners externally (from the external service/app) can be time-consuming. To increase productivity, you can register a dummy event to trigger your event listeners internally without ever leaving the ScriptRunner Connect app.

You can configure the dummy event by opening the event listener and then going to the Test Event Payloads tab. You'll receive a dummy template that has already been created for you. You can modify it to suit your needs, and when you're ready, click the Play button in the event listener node in the resource tree to trigger your event listener with the dummy event. You can create as many dummy events as you like.

Available Event Listeners

ScriptRunner Connect is equipped with connectors for the following apps and services with available event listeners: