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 alert activities occur (such as an alert 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.

Flow triggers

Alert activity triggers

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

Common properties

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

Alert status updates trigger

The Alert Status Updates trigger initiates a flow when an alert is started, suspended, resumed, or terminated. Outputs include the status of the alert and the user who initiated the alert 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.

Alert comments trigger

The Alert 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 alert (if it was escalated manually), the type of escalation, the recipients the alert escalated from, and the recipients the alert 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 alert. 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

 

Callable trigger

A callable trigger initiates a flow when a step in a different flow 'calls' it to run. Adding a callable trigger to the canvas automatically adds an associated callable flow step to the Tools tab of the palette. You can add the callable flow step to one or more flows on any of the canvases in your workflow. Whenever the callable flow step runs as part of a flow, it initiates the callable trigger to run the sequence of steps connected to it.

When you add a callable trigger to your canvas, you'll have to set up its associated callable flow step and define its inputs. The inputs of the callable flow step are available as outputs of the trigger. This allows you to pass information from the calling flow to the steps connected to the callable trigger.

^ Back to top

 

HTTP Request trigger

HTTP Request triggers initiate a flow when they receive a POST request sent 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 Initiation trigger

An Email Initiation trigger initiates a flow when you send an email to the trigger. When the trigger 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 Initiation trigger and a Create Alert Using a Form step.

^ Back to top

Incident Initiation trigger

The incident initiation trigger (formerly known as the form trigger) lets you and your team initiate incidents by filling out and submitting a Flow Trigger form (you need a form of this type in your workflow to configure an initiate incident trigger). This lets you initiate an incident without sending notifications if your process doesn't require it.

^ Back to top

Incident Automation trigger

The incident automation trigger lets you and your team automate a flow from the Incident Console or on an incident service dependencies map. To configure an incident automation trigger, you need to associate it with a Flow Trigger form in your workflow. The name of the associated flow trigger form will be the name of your automation, which you can run from an incident or an impacted service without leaving your incident resolution process.

^ Back to top

Incident activity triggers

The Initiate Incident step includes built-in triggers that you can use to trigger flows when certain conditions change or a particular action is taken on an incident, including status changes, severity changes, and notifications to engage as incident resolvers. These triggers include a common set of incident context outputs, plus additional outputs specific to the type of trigger.

Incident trigger context

Incident activity triggers share a common set of 'Incident trigger context' outputs with details about the incident at the time the trigger fired. You can use these outputs to pass current incident details to steps further along in your flow.

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, the note the user added when the status was changed, and context about the incident at the time the trigger was initiated.

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, the note the user added when the severity was changed, and context about the incident at the time the trigger was initiated.

^ Back to top

Notify to Engage trigger

The Notify to Engage trigger initiates a flow whenever someone selects 'Notify to Engage' to add resolvers to incidents created by the Initiate Incident step the trigger is connected to. The main purpose of the trigger is to modify the default message that's sent to resolvers when you invite them to engage in the incident.

When you add the trigger to the canvas, Flow Designer automatically connects a Create Alert step to the trigger with a version of the default message that you can customize to suit your organization's needs. The presence of the Notify to Engage trigger on your canvas signals Flow Designer to initiate the trigger and run any flow attached to it instead of sending resolvers the system's built-in notification to engage in the incident.

^ Back to top