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 On-Demand for Boundary integration.
The integration to Boundary:
- Leverages built in Actions
- Can be associated with any trigger
- Is outbound only.... for now...
- Relevant details about the alarm are sent to xMatters for easy display in notifications
Before configuring anything in Boundary, xMatters will need to be configured first.
The first step in configuring xMatters is to create a REST API 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 Client Assistance to create it for you. (For detailed procedures about creating the role, see Authentication and Permissions.)
In the following example, this role is named "REST Web Service User".
To create a REST API 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 Full Access 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 will be 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 communication plan.
To import the Boundary communication plan:
- Download the attached .zip or tar.gz file to your system, and then extract the contents.
- In the target xMatters system, on the Developer tab, click Import Plan.
- Click Choose File, and then locate the following file within the extracted archive:
- Click Import Plan.
- Once the communication plan has been imported, click Plan Disabled to enable the plan.
- In the Edit drop-down list, select Forms.
- For the CPU Action form, in the Not Deployed drop-down list, click Create Event Web Service.
- After you create the web service, the drop-down list label will change to Web Service Only.
- In the Web Service Only drop-down list, click Permissions.
- Enter the REST API user you created above, and then click Save Changes.
- Repeat steps 7-9 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.
- Note that the Access Web Service URL option appears twice in the drop-down menu. Ensure that you click the option just below Create Event Web Service.
- You'll 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 REST API endpoint. This is the url copied from the form as described in the "Import communication plan" section, above.|
|Username||The REST API Username to authenticate to xMatters.|
|Password||The password for the REST API User above.|
|Target Group or User||The 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.