Flow tools

Tools are steps that use information coming through a flow to decide what action to take next or to gather additional information from xMatters to use in the flow. They help you create richer, more refined flows adapted to your use cases.

  • Switch steps (in the Utilities section) split a flow onto different paths (for example, use path A if the event is customer impacting but use path B if it's not).
  • Event steps let you create, find, or terminate events in xMatters at any point in a flow, using information from previous steps.
  • Find in xMatters steps let you look up information on users in xMatters based on search criteria entered in the inputs.

Utility steps

The Utilities steps let you modify your flow based on information coming from previous steps.

Switch step

A switch step functions like the switch on a set of railway tracks. It determines which route the train — or flow — needs to take next. You can base this decision point on the value of event properties, trigger outputs, constants, or outputs of previous steps in the flow.

Here are a few examples of how you can use a switch step:

  • The value of a "Severity" property: "Critical" goes one way, "High" another, everything else follows a third, default path.
  • A success response from a Create Ticket step: "201" continues the flow, while "400" sends a notification that something went wrong.
  • The value of a "Team" property: "Alpha" follows one path that includes a "Post to Alpha Chat" step and "Beta" follows another path that posts to the Beta Chat channel.

Event steps

The Event steps let you work with xMatters events anywhere along your flow, including creating a new event at any point or finding existing events that match your specified search criteria.

xMatters Create Event

The xMatters Create Event step lets you create a new event at any point in the flow in response to previous steps, using information from those steps to populate event details and targeted recipients. You can target either the form the flow belongs to or another form in the communication plan.

For example, you might want to create a new event: 

  • In response to an email trigger, with the addressees in the email becoming the recipients of the event notification.
  • Based on an "Emergency alert - Location" switch step, creating events targeting different groups with different instructions if the location is Los Angeles versus London.
  • After an HTTP trigger, populating the event details using the values of properties in the request, including setting the recipients from an "Assignment Group" output on the trigger.
  • Create an event using a different form that targets your customer support team after a "Customer Impacting" switch step.

Get Events

Use the Get Events step to get the events IDs of the 50 most recent events in xMatters that match search criteria such as status, priority, or the value of an event property. You can combine search criteria to narrow your results or add multiple status or priority values to broaden the search.

Terminate Events

Use the Terminate Events step to terminate up to 50 events, using their event IDs. You can use the Get Events step earlier in the flow to retrieve the IDs for the events you want to terminate. When you terminate events in xMatters, it stops all processing, including canceling any active notifications, and cannot be resumed.

The Terminate Events step has no outputs.

Find in xMatters

The Find in xMatters steps let you retrieve xMatters user information based on the search criteria you enter in the inputs.

Find User

Use the Find User step to look up the ID and target name of an xMatters user based on the value of a custom field or attribute. For example, you could use this step to look up a user who has the value "Rigel" in a Team Lead field, and then use the output from this step to set that person as the recipient of a connected Create Event step.

The outputs provide the unique identifier (UUID) and target name of the first user that matches the search criteria.

Find User Property Value

Use the Find User Property Value step to look up the value of a custom field or attribute based on the ID and target name of an xMatters user. For example, you could look up what value the "Jira SD ID" field holds for user mmcbride and pass that value to a step further downstream so it can set the assignee in Jira.

The output provides the value of the specified custom field or attribute.