Outbound integrations

Outbound integrations enable web applications and integrations to extract information from an xMatters event and take action based on the properties of the event. You can configure the webhook used in an outbound integration for event status changes, event comments, device deliveries, targeted recipient failures, notification responses, and escalations. A webhook's payload contains information about the action that triggered it and may include the value of some form properties.

Outbound integration triggers

Whenever an outbound integration is triggered, it generates a webhook that includes information about the action that triggered the integration, the associated event, and the value of some form properties.

By setting a form property to be included in outbound integrations, you can relay any information that is available to the form when the event is initiated. You can even create form properties that are used exclusively for communicating to third-party systems. For example, you could create a form property that prompts the user to select a category that exists in the third-party system. This value is passed to the webhook but doesn't need to be included in the message body of notifications that are sent to recipients.

Every webhook includes some common information:

  • event identifier: a unique identifier that can be used to track the event that triggered the integration
  • date: the date and time the webhook is created
  • event properties: values of form properties flagged to be included in the webhook

In addition to this common information, each type of webhook payload includes information about the action that triggered it.

For more detailed information about the specific JSON payload for each webhook, refer to the Integration Builder scripting reference.

Configure outbound integrations

The following instructions describe how to use the Integration Builder to configure an outbound integration to perform different actions in the cloud, or in your xMatters Agent or Integration Agent.

You can also now create mulit-step processes between xMatters and your DevOps and IT applications with our new visual-worfklow builder, Flow Designer.