The information in this article is the intellectual property of xMatters and is intended only for use with xMatters products by xMatters customers and their employees. Further, this intellectual property is proprietary and must not be reused or resold.
This article provides installation, configuration, and implementation details for the xMatters integration with Boundary.
The integration to Boundary:
- Leverages built in Actions
- Can be associated with any trigger
- Relevant details about the alarm are sent to xMatters for easy display in notifications
Before configuring anything in Boundary, you need to configure xMatters first.
The first step in configuring xMatters is to create a user to authenticate REST web service calls when injecting events.
This user needs to be able to work with events, but not update administrative settings. The best way to create a user for this integration is to have a dedicated "REST Web Service User" role that includes the permissions and capabilities. If this role does not exist in your deployment, you will need to create it, or ask xMatters Customer Support to create it for you.
In the following example, this role is named "REST Web Service User".
To create an integration user:
- Log in to the target xMatters system.
- On the Users tab, click the Add New User icon.
- Enter the appropriate information for your new user.
- Assign the user to the REST Web Service User role.
- Click Save.
- On the next page, set the web login ID and password.
- Make a note of these details; you will need them when configuring the Boundary side of the integration.
Recipients to the Boundary alarms are set in the action when it is created in Boundary. See below for details.
You can create multiple groups and users at once using the EPIC feature.
The next step is to import the Boundary workflow.
To import the workflow:
- Download the attached .zip file to your system.
- Browse to the .zip file, or drag it onto the Import Workflow dialog box.
- Click Import Workflow.
- Once the import is finished, the workflow should be automatically enabled. If it isn't, click the Disabled toggle to enable it.
- Click the gear icon beside the workflow, and select Editor Permissions.
- Add the integration user, and then click Save.
- Click the workflow name to open the Forms tab.
- For the CPU Action form, in the Web Service Only dropdown, click Sender Permissions.
- Enter the integration user, and then click Save Changes.
- Repeat steps 7-8 for the Memory Action form.
To get the web service URL for a form, in the Web Service Only drop-down list, click Access Web Service URL. Copy the highlighted URL at the top of the dialog box.
- You need these URLs when you configure the Boundary action.
Now that you've configured xMatters, it's time to configure Boundary.
The xMatters action has already been enabled in Boundary.
To set up the action:
- Click Settings > Actions and locate the xMatters action:
- Click Add to display the Action settings:
- Enter the information in the fields as explained in the following table:
|Field Name||Field Description|
|Name||Name of the action; this should be the same as the form name in xMatters.|
|Endpoint URL||The xMatters endpoint. This is the URL copied from the form when you imported the workflow.|
|Username||The username of the integration user used to authenticate into xMatters.|
|Password||The password for the integration user.|
|Target Group or User||The xMatters Group or User this action should target. Note that if you are using a subscription, this is not required.|
|Priority||Determines the message send priority.|
- Click Save.
You can test the integration by sending a notification email from within Boundary.
To test the integration:
Create a new Alarm or open an existing Alarm. Add the newly created Action (CPU Action for example) to the Actions section of the Alarm. Then trigger this alarm. A new event should be created in xMatters.
First, add an email Action to the alarm. Was the email received? If so, check xMatters to see if the event was created there. If not, verify the conditions of the Alarm to make sure it is actually being triggered.