Integrator > Integration Builder

Integration Builder

The Integration Builder, in combination with the other elements of the xMatters integration platform (including the REST API, Integration Agent, and email integration), allows you to easily add an automated, closed-loop communication plan to address any business interruption.

You can use the Integration Builder within the xMatters On-Demand web user interface to create an integration between your communication plan and another application. You can create multiple integrations for a single communication plan.

How it works

Inbound integrations

Inbound integrations are primarily used to create an event in xMatters using a communication plan. The transformation script for an inbound integration can receive an incoming HTTP request, parse and modify its data, enrich the data using additional web requests, and finally create an event to send notifications.

Create an inbound integration to have an external application create an event or take action in xMatters.

Outbound integrations

Outbound integrations are triggered when actions take place in xMatters. The outbound services can make web requests to any API accessible over the Internet. You can use outbound integrations to update the originating event with status changes or response information. You can also configure callbacks to create new events in xMatters; for example, to start a conference bridge or send additional notifications to recipients based on their actions.

Create an outbound integration to have xMatters send out response or event information to take action in another application.

Transformation script editor

The Integration Builder includes a full-featured, browser-based script editor that allows you to create and modify your transformation script within the xMatters web user interface. Transformation scripts for the Integration Builder are written in JavaScript (ECMAScript 5.1).

  • Want to get starting creating a request? Check out the request object details on the inputs page.

HTTP Endpoints

Each web request you want to make using the Integration Builder is represented in the transformation scripts by HTTP request to an endpoint. Each endpoint is configured with a base URL, a name, and optional configuration parameters, such as the request method (GET, POST, etc.), a specific path to append to the base URL of the endpoint, and any request headers, parameters, or body data.

Activity Stream

The Integration Builder includes an Activity Stream that records request activity and displays it within the web user interface.

Integrations you create using the Integration Builder are automatically included when you export and import a communication plan. You do not need to export or import them separately.