User steps

Find User

Use the Find User step to look up the ID and target name of an xMatters user based on specific values of a selected property (such as the user's email address, target name, web login, or the value of a custom user property). 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 Alert Using a Form step.

If there is more than one matching user, only the first user is returned. The outputs provide the unique identifier (UUID) and target name of the first user that matches the search criteria.

  1. Drag a Find User step onto the canvas.
  2. Double-click the step to open the setup screen (or move your cursor over the step and click the pencil icon).
  3. Edit the Step Label to give the step a unique label for the particular flow.
  4. Select a property to use for the user lookup:
    • Select Email and enter an email address.
    • Select Target Name and enter a target name.
    • Select Web Login and enter a web login ID.
    • Select Custom and enter a custom user property (using plain text or a constant) that you want to find a value for into the Custom Property Name field, and a value (using plain text or an output from the previous step) that you want to find a match for into the Custom Property Value field.
  5. Click Done.
  6. Click Save on the canvas.

The Find User step uses the xMatters endpoint, which authenticates using the credentials of the user who triggered the flow.

Output Description Example
User ID UUID of the first xMatters user matching the search criteria. 25dce2c3-defe-4610-8c55-4c6edbf50496
User Target Name Target name of the first xMatters user matching the search criteria. asamara
Total User Count

The total number of users found that match the search criteria.

You could connect a custom step that checks if the value of this output is greater than 1, then connect a switch step to take a different path if that is true.

2

Find User Property Value

Use the Find User Property Value step to look up the value of a custom user property 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.

  1. Drag the step onto the canvas.
  2. Double-click the step to open the setup screen (or move your cursor over the step and click the pencil icon).
  3. Edit the Step Label to give the step a unique label for the particular flow (for example, "Find ServiceDesk ID").
  4. Enter the target name or ID of the xMatters user you want to find the value for in the User ID input.
  5. Enter the name of the custom user property you want to find the value for into the Property Name field.
    • If you're repeatedly looking up the value of the same property, you can store the name of the field in a constant, then drag the constant into the input. This helps prevent the flow from tripping over a typo. Otherwise, you can enter plain text or use an existing output from another step in the input field.
  6. Click OK.
  7. Click Save on the canvas.

The Find User Property Value step uses the xMatters endpoint, which authenticates using the credentials of the user who triggered the flow.

Output Description Example
Property Value Value of the specified custom field or attribute for the specified xMatters user. marymc3