<iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M74D8PB" height="0" width="0" style="display:none;visibility:hidden">
Loading
Skip to NavigationSkip to Main Content
How to Trigger a Flow – 6 Ways to Run a Flow
Workflows
Okta Classic Engine
Okta Identity Engine
Overview

There are six ways to trigger a flow. They are:

  • Schedule (flow runs periodically)
  • Event (flow is called when a particular event is fired)
  • Manual (clicking the Test button)
  • API endpoint (another system invokes a flow via an API endpoint)
  • Helper flow (flow calling another flow)
  • Delegated flow (let someone else in the organization invoke it)
Applies To
  • Okta Workflows
Solution
  1. Schedule flow (runs periodically)

A flow can be scheduled to run periodically. For example, schedule a flow to run every hour, every day, or once a week (there are other options also).

To schedule a flow, add the Schedule event:

Events to trigger a flow  

 

To configure the schedule, click the clock icon (🕔) at the bottom of the card:

A flow that runs on schedule 


Options to configure when to run a flow:

Flow schedule options

 

  1. Event flow (is called when a particular event is fired)

Another way to trigger a flow is when a particular event occurs in an organization. For example, this flow will run when a user is added to a group:

Trigger a flow when a user is added to a group

 

Every connector supports different events:

Events available from the Okta connector 

 

  1. Manual (clicking the Test button)

If a flow needs to run manually, infrequently, or just once, use the Test button to trigger it. Even though it says Test, this is a perfectly fine way to run a flow.

Running a flow via the Test button 

When manually running a flow, there is no need to have an event card set (1st card).

 

  1. As an API endpoint (another system invokes a flow via an API endpoint)

It is possible to trigger a flow from an external system via an API endpoint. For example, an event occurs in an external system, which makes a call to an API endpoint that triggers a flow.

To trigger a flow via an API endpoint, use the API Endpoint event card:

Triggered a flow via an API endpoint


The API endpoint information is available by clicking the </> icon at the bottom of the card.

API endpoint settings


To test an API endpoint, use a service such as Postman.

 

  1. Helper flow (flow calling another flow)

A helper flow is a flow that is called from another flow. A helper flow is usually used when there is a list of objects (users, groups, etc.), and a need to iterate over each item in a list to perform an action.

In this example, a flow named Check last login will be called for each user found with the List Users with Search card:

Calling a helper flow

Helper flow is called for each item in a list:

Helper flow 


A flow becomes a helper flow when using the On Demand – Helper Flow event card:

Flow trigger event cards


Flow chart view of the main flow and helper flow:

Main flow and helper flow  

 

  1. Delegated Flow (let someone else in the organization invoke it)

A delegated flow is when another user is delegated to run a flow. That person might not be an administrator but needs to be able to trigger a particular flow.

To make a delegated flow, add a Delegated Flow event card:

Delegated flow event card

 

A delegated flow event card can define one or more inputs. In the screenshot below, the flow has two inputs: Name and ID.

Delegated flow 


Flow execution is delegated to another user within an organization. In the screenshot below, the user stella.green can run this flow:

A flow delegated to a user to run

 

When Stella invokes the flow, Stella will need to enter flow inputs:

Delegated flow inputs 


Looking at the flow history after Stella triggered the flow:

Delegated flow history


Related References

Loading
How to Trigger a Flow – 6 Ways to Run a Flow