/
Integrate with StackStorm

Integrate with StackStorm

Owned by Shivi Sivasubramanian
Last updated: Aug 06, 2024 by Meghali Deb Roy (Deactivated)
2 min read

What does the integration offer?

Use Compass's pack in StackStorm to perform most API actions used in Compass. Automate systems easily by using StackStorm's other abilities, like triggering a rule. Compass 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?

Use defined actions of Alert API, Heartbeat API, Integration API, Policy API, User API, Team API, WhoIsOnCall API, and more in StackStorm, then see the results on the Compass side.

Set up the integration

StackStorm is an API integration. Setting it up involves the following steps:

  • Add a StackStorm integration in Compass

  • Configure the integration in StackStorm

Add a StackStorm 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 a StackStorm integration in Compass, complete the following steps:

  1. Go to your team’s operations page.

  2. On the left navigation panel, select Integrations and then Add integration.

  3. Run a search and select “StackStorm”.

  4. On the next screen, enter a name for the integration.

  5. Optional: Select a team in Assignee team if you want a specific team to receive alerts from the integration.

  6. Select Continue.
    The integration is saved at this point.

  7. Expand the Steps to configure the integration section and copy the API key.
    You will use this key while configuring the integration in StackStorm later.

  8. Select Turn on integration.
    The rules you create for the integration will work only if you turn on the integration.

Configure the integration in StackStorm

Use the StackStorm administrative web UI to install and configure the integration.

  1. Create a configuration file named opsgenie.yaml at the following location: /opt/stackstorm/configs in the following format:

    --- api_key: "XXXXXXXXXXXXXXX"

  2. Paste the API key copied previously into api_key.

  3. Copy the opsgenie.yaml file into /opt/stackstorm/configs.

  4. While updating the configuration in /opt/stackstorm/configs, remember to also configure StackStorm to load these new values by running the st2ctl reload --register-configs command.

  5. Check if the configuration file is set up properly.

  6. Navigate to Packs, search for Opsgenie, and select Install.

  7. To test the integration, navigate to the Actions tab and select an action to run. Review the results of the execution in the History tab.

Read more about StackStorm’s pack configuration.