/
Integrate with AlertSite UXM

Integrate with AlertSite UXM

What does the integration offer?

Compass has a webhook integration with AlertSite UXM. Use the integration to send AlertSite UXM incidents to Compass's API with detailed information. Compass acts as a dispatcher for AlertSite UXM alerts, determines the right people to notify based on on-call schedules, notifies via email, text messages (SMS), phone calls and iPhone and Android push notifications, and escalates alerts until the alert is acknowledged or closed.

How does the integration work?

  • When an availability or performance alert is created in AlertSite UXM, an alert is created in Compass automatically through the integration.

  • When the status of the alert is sent to Compass as "0", related alert is also closed in Compass.

Set up the integration

AlertSite UXM is an API-based integration. Setting it up involves the following steps:

  • Add an AlertSite UXM integration in Compass

  • Configure the integration in AlertSite UXM

Add an AlertSite UXM 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 AlertSite UXM 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 “AlertSite UXM”.

  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 endpoint URL.
    You will use this URL while configuring the integration in AlertSite UXM 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 AlertSite UXM

To configure the integration of AlertSite UXM with Compass, complete the following steps:

  1. Log into AlertSite UXM.

  2. Select Alerts > Alert Recipients.

  3. Select New Recipient.

  4. Optional: Enter a name.

  5. Paste the API URL copied previously from Compass into Recipient.

  6. Select “POST request to web server" for Mode.

  7. Submit the form.

  8. Select the new alert recipient from the Alert Recipients list.

  9. Select Alert Recipient Details > Edit Recipient.

  10. Go to the Availability Alerts tab.

  11. Select Alert whenever an error clears check if you want AlertSite to close your alerts.

  12. Submit the form.

Sample payload sent from AlertSite UXM

Create Alert payload

JSON

source=AlertSite&custid=C120095&company=no%20comp%20name&device_id=327587&device_name=http://google.com×tamp=2016-06-30%2011:15:35&status=7&errcount=1&status_text=HTTP%20error%20from%20web%20server&location=Manchester,%20UK&location_num=5060&device_typecode=a&device_type=Web%20Site%20API&transaction=0&http_status=HTTP/1.1%20502%20Bad%20Gateway&

Read more about AlertSite’s alert data fields.

Compass parses the payload as follows:

JSON

{ "source":"AlertSite", "custid":"C120001", "company":"no comp name", "device_name":"http://google.com", "device_id":"327587", "timestamp":"2016-06-30 11:51:24", "status":"7", "errcount":"1", "status_text":"HTTP error from web server", "location":"Manchester UK", "location_num":"0", "device_typecode":"0", "device_type":"Web Site API", "transaction":"0", "http_status":"HTTP/1.0 502 Bad gateway" }