Skip to main content

Connectors: xMatters

Legacy Documentation
You're viewing legacy documentation for API Fortress (deployed via an on-premises container). To view documentation for the new SaaS version of API Fortress — now known as Sauce Labs API Testing and Monitoring (with Sauce Connect tunnels) — see API Testing on the Sauce Labs Cloud.

This connection with xMatters allows you to notify on-call responders based on failures in your API Fortress tests. Send critical information on the failure as well as a link to the test report from the failed test.

Below is a quick guide to setting up and using the xMatters connector.

note

This connector does not come pre-loaded out of the box for self-hosted/on-premises, and will need to be loaded separately. To learn how to load the connector into your API Fortress instance click here.

  1. Go to settings page

    CogWheel

  2. Click on “Alert Groups”

    AlertGroup.png

  3. Create a new group or add a connector to an existing alert group

    xmatters_alertgroup.png

  4. Add a new connector

    xmatters_newconnector.png

  5. Choose the xMatters connector

    xmatters_connector.png

  6. Configure the connector

    screenshot
    1. trigger_url is the url found in your "inbound integration" settings for your workflow: xmatters_trigger.png
    2. recipients are the users or groups you would like alert in your xMatters instance. (ex: userid1,userid2 or groupid)
    3. The base URL for your API Fortress instance should be in the constant "API Fortress Base URL" this will be used to build the url for your test report link.

  7. Go into project settings for a project you would like xMatters alerts set up for

    Settings.png

  8. Add the alert group that contains your xMatters connector to this project

    screenshot.png