Flow triggers

What triggers it: The trigger receives an incoming HTTP request from an external system to the trigger's URL.

What information is in the outputs: Properties or information from the request mapped to outputs by the user that created the trigger.

Examples of when to use this trigger:

• To inject information into Flow Designer from any system capable of sending a POST request.

HTTP request trigger output details

HTTP triggers do not have a standard set of outputs because the outputs, and mapping of request properties to these outputs, are defined by the user that created the trigger.

Each HTTP trigger is authenticated independently, using the authentication method set by the trigger creator (unless the creator set the trigger to allow all methods).

Depending on the allowed authentication methods, you might need to select the authenticating user that should be used to authenticate requests. Regardless of the method chosen, any requests submitted to the trigger URL have the same permissions in xMatters as the authenticating user, whether that user was set in the step or their credentials were included in the request.

Authentication methods

When creating an HTTP trigger, you can allow only one of these methods to be used or select the Allow all methods option to allow any of them to be used. It's recommended that you choose the most secure method the calling system supports

Method	Description
URL Authentication	The system generates an API key unique to the authenticating user selected when the trigger is configured and appends that API key to the trigger URL. Any requests submitted to this URL have the same permissions in xMatters as the authenticating user. The URL does NOT grant permission to log into the xMatters web user interface. URL authentication is the least secure method of authentication because anyone with access to the URL can trigger the flow. This authentication method is not recommended unless the flow does not need to be secured.
Basic Authentication	Basic authentication requires the calling system to store the credentials of an xMatters user to send an HTTP POST request to the trigger URL. If the user resets their password in xMatters, you must also update the calling system with the new password for it to continue to be able to trigger the flow. You cannot use API key credentials to trigger a flow that is set to require Basic authentication; you must provide an xMatters user ID and password.
API Key Authentication	API Key authentication uses a randomly generated API key and secret which are then stored in the calling system. To authenticate a request using API key authentication, use basic authentication with the API key as the username and the secret as the password. An API key credential has the same permissions within xMatters as the associated user, and can authenticate any request as that user, including to trigger a flow, submit requests to the xMatters REST API, or initiate an integration. You cannot use the API key and secret to log into the xMatters web user interface. If your account does not have an API key credential, you can create a new set of API Key credentials in your profile (or the profile of a specific integration user). You can view your API key credentials or the credentials for any user you supervise on the API Keys tab within the user profile.
OAuth Authentication	OAuth authentication requires you to provide the OAuth credentials of an xMatters user to trigger the integration. For more information about using OAuth with xMatters, see OAuth authentication.

Once you create and share an HTTP trigger, you can reuse it in any flow. You can also create new versions of the trigger as your needs change.

Step 1: Create the HTTP trigger

When you create a new custom HTTP trigger, the first thing to do is set up how it appears in the palette: the name, description, and icon.

1. On the Triggers tab of the palette, click Create HTTP Trigger. This opens the New HTTP Trigger dialog box.
2. On the Settings tab, give the trigger a name and description. These appear in the palette, and help people know what this trigger does and if it's something they should use. People can give the trigger a different label when they add it to the canvas.
3. To change the icon used for the trigger, click Select Image. This opens an image library with a selection of icons, including a few default ones and any icons you've already added for your organization.
4. Click an icon in the library to select it. To add a new icon to the image library, click the Choose a file to upload link and browse to the file you want to use.
   1. For the best appearance on the canvas, we recommend using images that are 36 x 36 pixels. The maximum file size is 250 KB, and you can use a variety of common image formats: jpg, jpeg, gif, and png.
5. Once you've selected your image in the Image Library, click Select to go back to the step settings.
6. Set the step state and version information.
7. Select the Run Location where the step is allowed to run. Allowing the step to run on an xMatters agent lets it update and retrieve information from systems behind your corporate firewall.
   • Cloud: The step can only run in the cloud.
   • xMatters Agent: The step can only run on an xMatters agent.
   • Both: The person using the step in a flow can select where the instance of the step will run when they configure it.
8. Select the authentication method you want to allow the step to use. You can also select Allow all methods if you want users to be able to pick the method used when they configure the trigger.
9. If the trigger requires a specific payload, click + Add Configuration Payload and then enter it in the Configuration Payload field. Make sure to use the same format as the source application so users of the trigger can copy and paste it when they're configuring the webhook.
10. Click Close to return to the New HTTP Trigger configuration screen.
11. Click Save.

Step 2: Create the outputs

When you define the outputs, you're deciding what information this trigger should provide to steps further downstream. For properties from the request to be available to steps later in the flow, you need to use the script to map them to the outputs of the trigger (see the next step).

1. On the Outputs tab, click Add Step Output to create a new output.
2. Enter a name for the output. This name can be used to reference it in the script editor, and appears in the step setup screen where people can drag it into the input of a connected step.
3. Click Add Step Output for each additional output you'd like to create. To delete an output, click the 'x' icon next to the output.
4. When you're done adding outputs, click Save.

Step 3: Map the outputs

The Script tab is where you define the internal logic that takes the HTTP request from another application, transforms the incoming information, and maps it to the outputs. When you create a new HTTP trigger, the script only brings what is included in the payload. Properties of the form associated with your flow canvas are not available as outputs because HTTP triggers do not use the form to create an alert in xMatters. You need to map properties from the request to outputs of the trigger to use these properties in steps in your flow.

The Script tab includes an example script showing how to parse the payload from an incoming HTTP request, then extract information from the payload and map it to outputs. You can use it as a template and customize it to work with your flow. The trigger's built-in request object enables you to access elements of the request, including the payload contained in the request body and any URL parameters.

The following instructions describe how to add and configure an HTTP trigger in your flow.

HTTP trigger authentication

Each HTTP trigger is authenticated independently, using the authentication method set by the trigger creator (unless the creator set the trigger to allow all methods).

How to configure an HTTP trigger

1. On the Triggers tab of the palette, under HTTP Request, drag the custom HTTP trigger you'd like to use onto the canvas.
   • You can filter the HTTP triggers by triggers you own, triggers others have shared with you, or all triggers you have permission to use.
2. Double-click the trigger to open its configuration screen (or select it and click the pencil icon).
3. Change the Trigger Label if you'd like to customize the trigger's name for your flow.
4. If the step allows any authentication method, select the method you want to use in the Initiation settings.
5. If required by the authentication method, select whose credentials you'd like to use to trigger the flow. Click the list to display users who can authenticate the trigger, or start typing a username into the search field to filter the list (two characters are required).
   • Users only appear in this list if you supervise them (or are a company supervisor) and they are assigned the REST Web Services role.
6. Copy the trigger URL and Configuration Payload, if one is provided – you'll use these to configure the HTTP POST request that will be sent to the trigger.
7. Click Run Location to set where the trigger runs. This tab only appears if the trigger is allowed to run on an xMatters agent.
8. Select the location where you want this step to run: Cloud or xMatters Agent.
   • If you set it to xMatters Agent, select one or more agents from the list of available agents. To select an agent from the list, you must be a registered user of the agent and it must be version 1.4.1 or later. If you don't have any agents configured, click Add an xMatters Agent to go to the Agents page, which has instructions for installing the agent.
9. Click the Flood Control tab to edit the trigger's default flood control settings. For more information about these settings, see Trigger Flood Control.

To initiate the trigger, send a POST request to the trigger URL using the requirements of the configured authentication method:

• URL Authentication: Send an HTTP POST request to the trigger URL.
• Basic Authentication: Send an HTTP POST request to the trigger URL using basic authentication and an xMatters username and password.
• API Key Authentication: Authenticate the request using basic authentication and set the username to the API key and the password to the secret.
• OAuth Authentication: Include an access token in the request header. A client ID is required to obtain and refresh access tokens in the xMatters REST API. You can find the client ID for your company under Workflows > OAuth. For more information about using OAuth with xMatters, see OAuth authentication.

You can also click View Instructions for instructions on how to trigger the flow.

If you want to view the results of the trigger initiation in the Activity panel, make sure you've connected steps to the trigger. If the trigger isn't connected to anything, no activity information appears.

If you have permissions to edit a custom HTTP trigger, you can edit the configuration or create a new version of the trigger, share the trigger, or delete it (as long as it's not used in a flow). Click the settings menu for the trigger (the gear icon) and select Edit, Usage Permissions, or Delete.

Examples of when to use this trigger:

• Inject information from any external system capable of sending an email message; this might include custom applications or almost any cloud-based application, monitoring system, social media platform, e-commerce platform, or customer relationship management tool.
• Configure an output mapping that parses text from the email subject line or body (e.g., a ticket number in the email subject) and use that text as an output that can be used throughout the flow (e.g., as a reference for incident resolution tasks such as ticket correlation, escalation, or status updates).

Email Initiation trigger output details

Property	Description	Example
email.to	All the email addresses included in the To: field of the email that triggered the flow.	[0]: mmcbride@hq54b.example.com [1]: DatabaseAdmins@hq54b.example.com
email.sender	The user ID of the email initiator.	integrationUser
email.subject	The subject of the email message.	IT Alert: Database Unavailable
email.htmlBody	The content of the email sent as HTML.	<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40"> <head> ... </html>
email.plaintextBody	The content of the email sent as plain text.	The Oracle Database is not available.
email.from	The name and email address of the email initiator.	Mary McBride <mmcbride@example.com>
email.date	The date and time the email was sent.	Tue, 21 Jul 2026 08:01:00 +0000
email.cc	All the email addresses included in the Cc: field of the email that triggered the flow.	John Smith <jsmith@example.com>, Sarah Matthews <smatthews@example.com>
email.headers	A JavaScript object containing the headers of the email.	date: Wed, 5 Jun 2019 21:51:31 +0000 content-language: en-US from: admin <admin@example.com> MIME-version: 1.0 etc.
email.senderIp	IP address of the email initiator.	192.0.2.132
email.recipients	Target names of users or groups included in the To: field of the email that triggered the flow.	mmcbride,DatabaseAdmins

The unique email address that you use to initiate a flow is created from a target name, the trigger ID, and hostname of your xMatters deployment in the following syntax: <name>@<triggerID>.<hostname>

• <name>: The name can be the user ID of a specific user or the name of a group. For example, mmcbride@hr54b.mycompany.xmatters.com or DatabaseAdmins@hr54b.mycompany.xmatters.com. If a group name includes spaces, you can enclose it in double quotes; however, we recommend not using spaces in group names because many popular email clients do not permit spaces in email addresses.
• <triggerID>: By default, the trigger ID is a randomly generated combination of alphanumeric characters. You may want to change the trigger ID to be more readable, or you may want to change it to something hard to guess for security purposes. The trigger ID must be unique within your company.
• <hostname>: The URL that you use to access the xMatters web user interface without the "https://". For example, the hostname for https://mycompany.xmatters.com is mycompany.xmatters.com

If your hostname includes a regional or specific instance indicator, do not include it in the target email format. For example, if the URL you use to access xMatters is mycompany.na1.xmatters.com, do not include the na1 portion of the URL in the email address. Use just mycompany.xmatters.com.

You can find the target ID and sample email address for an Email Initiation trigger on its configuration screen in Flow Designer.

Understanding how Flow Designer uses trigger email recipients

Email Initiation triggers in Flow Designer do not create an alert in xMatters when they are initiated. The target name of the user or group named in the initiation email is mapped to the email.recipients output of the trigger, which you can use as an input to later steps in your flow, such as for the recipients of a Create Alert Using a Form step. To include more than one target name in the email.recipients output, add multiple addresses to the To: line of the email (one for each user or group), using the format described above.

For example, if the To: field of your trigger email includes the following user and group:

To: mmcbride@hr54b.mycompany.xmatters.com; DatabaseAdmins@hr54b.mycompany.xmatters.com; AllEmployees@hr54b.mycompany.xmatters.com

Then the email.recipients output would include this comma-separated list of target names you could use directly as input to the recipient field of an xMatters alert step:

mmcbride,DatabaseAdmins,AllEmployees

Flow Designer email triggers accept 9 and 10 character BATV-encoded email addresses. Be aware that even though spaces are allowed in email addresses, many popular email clients do not permit them, even when enclosed in quotation marks. We recommend not using spaces in group names if you plan to include them on a trigger initiation email and use them as recipients inputs on another step in a flow.

The Email Initiation trigger lets you select whether initiation emails can be sent from any email address or are only accepted when they are sent from an email address assigned to a device in xMatters.

For example, lets say Mary McBride has a work email device configured in xMatters with the address mmcbride@your-company.com. She also has a personal maryrocks@cloud-email.com address, but it's not assigned to a device in xMatters.

If the trigger is set to allow initiation from any address, Mary could send an email from her maryrocks@cloud-email.com address to initiate the Email Initiation trigger and execute the connected flow. The flow authenticates using the Authenticating User selected in the trigger settings (which may or may not be Mary).

If the trigger is set to only allow initiation from an address associated with an email device in xMatters, Mary has to send the email using her mmcbride@your-company.com email; emails from maryrocks@cloud-email.com are rejected. When Mary sends an email from a valid email address, the trigger is initiated and the flow executed using her credentials.

1. Drag the trigger from the palette onto the canvas.
2. Double-click the trigger to open its configuration screen (or select it and click the pencil icon).



3. Change the Trigger Label if you'd like to customize the trigger's name for your flow.
4. Select the authentication method:
   • Send from any email: An email sent from any email address will trigger the flow. The flow runs using the credentials of the user selected in the Authenticating User field.
   • Send from an xMatters email device: Only emails sent from an address associated with a valid xMatters device will trigger the flow. The flow runs using the credentials of the user associated with the email address.
5. Optionally, customize the Trigger ID. You may want to change the trigger ID to be more readable, or you may want to change it to something hard to guess for security reasons.
6. Click Copy Address to copy the trigger's email address to your clipboard, so that it's available when you're configuring an external system to email Flow Designer, or to share with other users who want to initiate the flow by email.
   • The sample email address shows how to initiate the trigger with your target name. When you initiate the trigger by email, you can replace your user ID with a different user ID or group name.
7. If you'd like, you can also click Test Email to automatically open your default email program so that you can send a test email to your trigger's email address and see if it triggers your flow (if you selected Send from an xMatters email device, make sure your default email is associated with an email device).
8. Click the Output Mapping tab to add a mapping if you want to extract data from an incoming email's subject line or body content and use that data as an output of the step. Fill in the following fields on the tab:
   • Output Name: The name of the output to which you're mapping the parsed data.
   • Output Description: Details about the output to which you're mapping the parsed data.
   • Email Property Source: Select whether you want to extract data from the Email Body in Plain Text, Email Body in HTML, or Email Subject.
   • Parsing Method: Define how data is parsed from the source.
     • Regex - Locates and extracts text that follows a defined pattern.
     • Tokens - Identifies text that appears between specified beginning and ending markers.

   

9. Click Add Mapping if you want to configure more outputs mapped to specific data extracted from the email.
10. Click the Flood Control tab to edit the trigger's default flood control settings. For more information about these settings, see Trigger Flood Control.
11. Once you've configured all the settings and output mappings for the step, click Done.
12. Click Save on the canvas.

To give you the flexibility to trigger a flow without creating an alert, the email doesn't automatically initiate an alert in xMatters. If you want to create an alert when the Email Initiation trigger is initiated, simply add a Create Alert step to your flow, either right after the Email Initiation trigger or after additional steps that gather more information to enrich the alert notification.

How can I assign an external system a valid email address in xMatters?

This is only applicable if you want to limit the trigger initiation to addresses associated with an email device in xMatters.

To enable xMatters to recognize emails from your external system, do one of the following:

• Add the external system email address as a device for a user that is already authorized to initiate the form.
• Create a new user in xMatters to represent the external system. Give this user permission to access to the flow, and create a device for the external system email address.
• Use a service that can receive an email message from your external system and resend it using an email address that is authorized to initiate the flow.

Check the Devices screen in a user's profile to confirm that the email address that you are sending the initiation email from matches the address for one of their email devices.

If your system does not have the ability to send email messages, check out services like Zapier, which can be used to send email messages from a wide range of popular applications.

What happens if I use the Cc: or Bcc: lines instead of the To: line?

The Cc: and Bcc: fields are treated the same as the To: field. You can initiate alerts by including email addresses in the Cc: and Bcc: fields. Users or groups added to the Cc: and Bcc: fields are also included in the email.recipients output.

The sample email address shows how to inject my own target name with the email. How can I add other uses or groups to the To: field so they're included in the email.recipients output?

• To add another user instead of yourself, use their user ID before the @ symbol in the trigger email address.
• To send to a group, use the group name before the @ symbol. (Spaces or quotation marks in the name of the group are not recommended.)
• To target multiple recipients, use multiple addresses on the To: line.

What happens if I put email addresses for different flows in the same email?

Flow Designer will trigger each flow that you provided a trigger email address for in the To: field of the email, as if you had emailed the trigger addresses separately.

What happens if you include "regular" (non-trigger) email addresses in the To: line?

If you include an additional email address not associated with a flow trigger in the To: line along with one or more trigger email addresses, you'll send that email address a copy of the email. The flow is triggered but that email is not included in the trigger outputs. Email addresses must follow the trigger email initiation format to be included in outputs of the trigger.

What happens if my email server changes the To: address when sending?

Some email servers have a feature called "CNAME expansion" enabled that can alter the "To:" address of an email to include routing information. So an email sent to mmcbride@traveladvisory.example.xmatters.com might be changed during transit through your email server to something more like mmcbride@us1-west-1.mail_traveladvisory.example.xmatters.com.

To address this problem, you'll need to work with your IT team to disable the CNAME expansion feature or setting on your SMTP email server.

Examples of when to use this trigger: As an easy way to set up a simple flow that alerts your users when you send a webhook to the trigger URL using a provided payload.

What triggers it: The trigger receives an incoming HTTP request to the trigger's URL from an external system.

What information is in the outputs: The outputs of the trigger include information about the alert and its intended recipients, as defined in the configuration payload sent by the source application.

Simple Webhook - Alerts trigger outputs

Output	Description	Example
Recipients	Target names of users or groups to target as recipients of the alert.	mmcbride,akaur
Summary	A brief summary of important information to use as the subject of the notifications.	An alert was triggered
Description	Additional details to include in the body of the notifications.	The alert's impacted area
Priority	Priority level of the alert in xMatters (HIGH, MEDIUM, or LOW).	MEDIUM

1. Drag the Simple Webhook - Alerts trigger from the palette onto the canvas. It is located under the Utility section of the Triggers tab.
2. Double-click the trigger to open its configuration screen (or select it and click the pencil icon).
3. On the Settings tab, click the pencil icon next to the step's name to modify its label on the canvas (optional).
4. Select the authentication method you want to allow the trigger to use. You can select Allow all methods if you want the trigger to accept any of the available authentication methods.
5. Select the user whose credentials you'd like to use to trigger the flow. Click the list to display users who can authenticate the trigger, or start typing a username into the search field to filter the list (two characters are required). Alternatively, you can create an integration user to use as the authenticating user.
6. Copy the URL and Configuration Payload and use them to set up the webhook in the source application.
7. Click the Flood Control tab to edit the trigger's default flood control settings. For more information about these settings, see Trigger Flood Control.
8. Click Done.
9. Drag the Create Alert step from the palette onto the canvas and connect the trigger to it. It is located under xMatters on the Tools tab.
10. Double-click the Create Alert step to open its configuration screen (or select it and click the pencil icon) and do the following:
    1. On the Setup tab, drag the Recipients output of the trigger into the Recipients field.
    2. Use the Message Templates to define the Email / App, Text, and Voice notifications for your alert, using the Summary and Description outputs of the trigger in the message subject and content.
    3. On the Handling & Overrides tab, expand the Alert Handling drop-down and select Use Output or Constant Value for the Priority field, then drag the Priority output from the trigger into this field.
11. Define the response options, device settings, and other options for your alerts. For detailed instructions, see our Create Alert step documentation.
12. Click Done.
13. Save the canvas.

Examples of when to use this trigger: As an easy way to set up a simple flow that initiates an incident and alerts users when you send a webhook to the trigger URl using a provided payload.

What triggers it: The trigger receives an incoming HTTP request to the trigger's URL from an external system.

What information is in the outputs: The outputs of the trigger include information about the incident and its intended resolvers, as defined in the configuration payload sent by the source application.

Simple Webhook - Incidents trigger outputs

Output	Description	Example
Summary	A brief summary of important information to help responders quickly triage the incident.	An incident was detected.
Description	Additional details to help responders diagnose and resolve the problem.	There is a problem that was detected that triggered this incident.
Severity	The importance of resolving the incident relative to other issues.	MEDIUM
Impacted Services	Business, technical, or external services impacted by the incident.	API,Webstore
Resolvers	Names of users or groups to target as resolver of the incident.	mmcbride,Proxy,Web Team
Incident ID	ID of the incident that can be used to look up whether an alert with a matching incident ID already exists.	INC-1234
Incident Commander	Target name of the user assigned as Incident Commander. If no one is specified, the user who initiated the flow is assigned this role.	mmcbride

1. Drag the Simple Webhook - Incidents trigger from the palette onto the canvas. It is located under the Utility section of the Triggers tab.
2. Double-click the trigger to open its configuration screen (or select it and click the pencil icon).
3. On the Settings tab, click the pencil icon next to the step's name to modify its label on the canvas (optional).
4. Select the authentication method you want to allow the trigger to use. You can select Allow all methods if you want the trigger to accept any of the available authentication methods.
5. Select the user whose credentials you'd like to use to trigger the flow. Click the list to display users who can authenticate the trigger, or start typing a username into the search field to filter the list (two characters are required). Alternatively, you can create an integration user to use as the authenticating user.
6. Copy the URL and Configuration Payload and use them to set up the webhook in the source application.
7. Click the Flood Control tab to edit the trigger's default flood control settings. For more information about these settings, see Trigger Flood Control.
8. Click Done.
9. Drag the Initiate Incident step from the palette onto the canvas and connect the trigger to it. It is located under xMatters on the Tools tab.
10. Double-click the Initiate Incident step to open its configuration screen (or select it and click the pencil icon).
11. Drag outputs of the trigger into their corresponding fields on the Setup tab of the Initiate Incident step.
12. Click Done.
13. Drag the Create Alert step from the palette onto the canvas and connect the Initiate Incident step to it. It is located under xMatters on the Tools tab.
14. Double-click the Create Alert step to open its configuration screen (or select it and click the pencil icon) and do the following:
    1. On the Setup tab, drag the Recipients output of the trigger into the Resolvers field.
    2. Use the Message Templates to define the Email / App, Text, and Voice notifications for your alert, using outputs of the trigger in your message subject or content.

15. Define the response options, device settings handling options, and other options for your alerts. For detailed instructions, see our Create Alert step documentation.
    1. Note that only responses with a Positive contribution value will display the responder as "Engaged" in the Resolvers list in the Incident Console.
16. Click Done.
17. Save the canvas.

What triggers it: The trigger runs a flow on a set schedule.

What information is in the outputs: The time when the trigger was scheduled to run in epoch, UTC, and ISO with time zone formats.

Examples of when to use this trigger:

• To check the status of a specific service.
• To integrate with a tool via API that cannot send signals to Flow Designer.

Scheduled trigger output details

Property	Description	Example
Scheduled Date Time (epoch)	Time when the trigger was scheduled to run using epoch format.	1715786816
Scheduled Date Time (UTC)	Time when the trigger was scheduled to run in UTC using ISO format.	2024-05-15T15:26:56Z
Scheduled Date Time (Time Zone)	Time in the configured time zone when the trigger was scheduled using ISO format.	2024-05-15T11:26:56-04:00

1. Drag the Scheduled Trigger from the palette onto the canvas. It is located under the Utility section of the Triggers tab.
2. Double-click the trigger to open its configuration screen (or select it and click the pencil icon).
3. On the Setup tab, click the pencil icon next to the step's name to modify its label on the canvas (optional).

   

4. Select the user whose credentials you'd like to use to trigger the flow. Click the list to display users who can authenticate the trigger, or start typing a name into the search field to filter the list (two characters are required). Alternatively, you can create an integration user to use as the authenticating user.
5. Set the time zone in which the scheduled trigger should run. If no time zone is selected, the time zone of the authenticating user is used.
6. Use the date and time pickers to set the first occurrence of the trigger.
7. Set how often the trigger should repeat, by selecting either Minutes, Hourly or Daily and entering a value into the field.
8. To add an optional End Date, click Add End Date, select On Date and user the calendar to set the end date.
9. Review the information box to confirm that the trigger will fire on the schedule you want.

At this point, you can either enable the trigger and click Done to save your changes, or save the changes leaving the trigger disabled. You can create Scheduled triggers and leave them disabled until you're ready to use them. When you're ready to run the Scheduled Trigger, click Enable.

The number of schedule triggers that can be enabled at one time is determined by your plan type. If you have more scheduled triggers on your canvas than your plan type allows, when you save the canvas, the maximum number of scheduled triggers are enabled, and the rest are left as disabled. You can then manually enable and disable the triggers as required.

Once your scheduled trigger is on your canvas and configured, you have the following options available on the canvas: 

• View the next occurrence of when the trigger will run.
• Manually run the trigger.

View the next scheduled occurrence

Hover over the trigger to view the next occurrence of any Scheduled Trigger. A tool tip appears displaying the next time the trigger will run.

Manually run the trigger

When you have a trigger on the canvas, you can test the configuration to ensure the everything works as you expect. Rather than re-configure the trigger to test it, expand the options menu and select Trigger Now. The trigger immediately runs based on its current configuration settings.

What triggers it: When its associated callable flow step runs in another flow in your workflow.

What information is in the outputs: Inputs of the callable flow step are available as outputs of the callable trigger. This allows you to pass information from the calling flow (the flow containing the callable flow step) to steps connected to the callable trigger. Callable flow steps do not currently return any information from the flow they call, apart from the ID of the request that initiated the callable trigger.

Examples of when to use this trigger: If you want to reuse the same sequence of steps in multiple flows and make your flows more readable and easier to maintain.

1. Drag the Callable Trigger from the palette onto the canvas (available from Triggers > Utility).
2. Double-click the trigger to open its configuration screen (or select it and click the pencil icon).
   • If prompted, click to Save Changes to the canvas.
3. Click Create Callable Flow Step to create the step which you can use to call your trigger.
4. On the Settings tab, give your callable flow step a name, description, and icon.
   • This helps people looking at the step on the Tools tab understand what the callable flow step does if they add it to their flows.
5. On the Inputs / Outputs tab, define the inputs of the callable flow step, which will also be available as outputs the callable flow trigger.
   1. When you add the callable flow step to a flow, you can pass information from the previous steps of that flow to the steps connected to the associated callable trigger.
6. Click Save.
7. Click Close to return to the trigger configuration screen. The Settings tab of your trigger displays information about its associated callable flow step.
   • Click Open Step Configuration if you want to make further updates to the callable flow step's settings or inputs.
   • Click Show Step in Palette to view the location of the callable flow step on the Tools tab.
8. If you want to limit who can initiate the trigger, modify the Usage Permissions of its associated callable flow step, available from the step's Settings menu (the gear icon) on the Tools tab of the palette.
9. You can manage the trigger's flood control settings on the Flood Control tab, or in Workflows > Workflow Tools > Flood Control.

You're now ready to connect the series of steps to your callable trigger, and to add the trigger's associated callable flow step to your flows. Once you've added the callable flow step to one or more flows, the Settings tab of your trigger will include a Usage list of the locations (Canvas > Trigger Name) where the callable flow step is used.