Flow triggers

A trigger is the mechanism for kicking off a flow in xMatters. Flow Designer includes different types of triggers, which are initiated either when event activities occur (such as an event status change, a specific response, or an added comment), or when information is injected into xMatters by an incoming HTTP request or email. Each trigger populates outputs based on the type of trigger, which are available to downstream steps in a flow. They can be easily identified in Flow Designer canvases by their circular icon.

Triggers only fire if there are steps connected to them (the exception is any legacy Integration Builder triggers, which continue to execute the scripts associated with them).

If you have existing outbound integrations for a form, they'll appear as triggers on the canvas. You can connect additional steps to these triggers to extend the current functionality of your outbound integrations.

The maximum number of requests you can submit within a one-minute period to xMatters is limited by your pricing plan. If you exceed this limit, your request will be rejected with a 429 error and will not be queued for processing.

Event activity triggers

Event activity triggers kick off flows based on different event lifecycle activities, including event status updates, device delivery updates, responses, event comments, escalations, and targeted recipient failures. Each of these different triggers include a common set of event properties, and additional properties specific to the type of event activity.

Common properties

The common properties output by all event activity triggers provide information identifying the event in addition to its status and properties.

Event status updates trigger

The Event Status Updates trigger initiates a flow when an event is started, suspended, resumed, or terminated. Outputs include the status of the event and the user who initiated the event status change.

Device delivery updates trigger

The Device Delivery Updates trigger initiates a flow when a notification is delivered to a device, or when notification delivery fails. Outputs include the user and device that the message was sent to and whether the delivery was successful.

Responses trigger

The Responses trigger initiates a flow when a user responds to a message. Outputs include the user and device that made the response, their response choice, and comments added from the mobile app.

Event comments trigger

The Event Comments trigger initiates a flow when a user adds a comment from the mobile app, xMatters Inbox, email, Tracking Report, or xMatters REST API. Outputs include the user that made the comment and the content of their comment.

Escalations trigger

The Escalations trigger initiates a flow when an escalation occurs in a group. Outputs include the group containing the shift with the escalation, the reason for the escalation, the user that escalated the event (if it was escalated manually), the type of escalation, the recipients the event escalated from, and the recipients the event escalated to.

Targeted recipient failures trigger

The Targeted Recipient Failures trigger initiates a flow when none of the targeted recipients could be immediately notified for an event. Outputs include the type of failure, the first 100 targeted recipients, and the total number of targeted recipients.

^ Back to top

App triggers

Flow Designer has built in triggers to receive and parse requests from common applications. See our App triggers section for information and instructions on the available triggers.

^ Back to top

 

HTTP Request trigger

HTTP Request triggers initiate a flow when xMatters receives a POST request to the trigger's URL. The HTTP trigger parses the payload from the incoming HTTP request, then extracts information from the payload and maps it to user-defined outputs of the trigger to be available as inputs to later steps in a flow.

^ Back to top

 

Email trigger

An email trigger initiates a flow when you send an email to xMatters. When xMatters receives an email from a valid sender, it initiates the corresponding flow and uses information from the email to set values for outputs of the trigger, available as inputs to later steps in a flow. Outputs include the email sender, headers, addressees, subject, and body.

If you have an existing integration using the legacy email initiation, we automatically converted to a flow consisting of an email trigger and a create event step.

^ Back to top

Form trigger

The form trigger lets you and your team initiate flows by filling out and submitting a Flow Trigger form (you need a form of this type in your workflow to configure a form trigger). This lets you initiate a flow without sending notifications, if that doesn't suit your process.

What triggers it: When a flow trigger form is submitted.

What information is in the outputs: Properties and parameters defined in the layout of the associated flow trigger form. The values at runtime depend on what's defined on the form layout and what's entered when the form is submitted

Examples of when to use this trigger: This step is primarily used in created your own custom incident management response flows. To initiate incidents when the associated form is submitted, connect an Initiate incident step to the form trigger.

Incident triggers

Incident triggers are built into the xMatters Initiate Incident step and can be used to trigger flows when certain incident conditions change, such as when an incident's status or severity are updated to a particular value. For example, a notification is sent to escalate incident response if an incident's severity level is changed to Critical, or a service desk ticket is closed if an incident's status is updated to Resolved.

A flow is triggered when an incident's status or severity is changed, not when an incident is initiated in xMatters (regardless of initial status or severity).

Status Change trigger

The Status Change trigger initiates a flow when an incident's status in xMatters changes to a specified value. Outputs include the new status, old status, the name of the user who changed the status, and the note the user added when the status was changed.

Severity Change trigger

The Severity Change trigger initiates a flow when an incident's severity in xMatters changes to a specified value. Outputs include the new severity, old severity, the name of the user who changed the severity, and the note the user added when the severity was changed.

^ Back to top