Integrate with XL Release
What does the integration offer?
Compass's XL Release integration triggers Compass notifications as part of your release process. Compass acts as a dispatcher for these notifications and determines the right people to notify based on on-call schedules, notifies via email, text messages (SMS), phone calls, and iOS and Android push notifications, and escalates alerts until the alert is acknowledged or closed.
How does the integration work?
Integration is enabled and disabled through a plugin in XL Release.
When an alert is triggered from a release in XL Release, an alert is created in Compass.
When the alert is closed in XL Release, the corresponding alert is closed in Compass.
When the alert is snoozed in XL Release, the corresponding alert is snoozed in Compass.
Set up the integration
XL Release is an API-based integration. Setting it up involves the following steps:
Add an XL Release integration in Compass
Configure the integration in XL Release
Add an XL Release integration
In this release, only incoming integrations are fully supported in the Standard plan, at a team level. To use outgoing integrations or the outgoing part of bidirectional integrations, upgrade to a higher subscription plan. There may be restrictions on how you can create and apply integration rules as well.
You can add this integration only from your team’s operations page. Adding an integration from your team’s operations page makes your team the owner of the integration. This means Compass only assigns the alerts received through this integration to your team.
To add an XL Release integration in Compass, complete the following steps:
Go to your team’s operations page.
On the left navigation panel, select Integrations and then Add integration.
Run a search and select “XL Release”.
On the next screen, enter a name for the integration.
Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.
Select Continue.
The integration is saved at this point.Expand the Steps to configure the integration section and copy the API key.
You will use this key while configuring the integration in XL Release later.Select Turn on integration.
The rules you create for the integration will work only if you turn on the integration.
Configure the integration in XL Release
To configure the integration of XL Release with Compass, complete the following steps:
Shut down the XL Release server.
Copy the plugin JAR file into the XL_RELEASE_SERVER_HOME/plugins directory.
Start the XL Release server.
Log in to XL Release. If already logged in, refresh the page.
Go to the Shared Configuration page.
Under Opsgenie:Config, select Add Config.
Enter a name for the integration in Title.
Paste the API key copied previously from Compass into Api Key.
Select Save.