Pause

The Pause function currently only works when used in Flows that are resumed programmatically. If you want to pause a Flow for a specific delay or until a specific time, use a Wait For or Wait Until function.

Overview

Pauses the Flow and returns the inputs using whatever interface was used to initiate the Flow, along with the Execution ID of the Flow, which is needed in the resume request.

In order to resume the Flow, you will need to call the Flow again with a specific URL Endpoint, appended with the Execution ID of the execution that you would like to resume. The endpoint is similar to the one that invokes the Flow (found on the API Endpoint card's Event Settings page), with one small change - replace 'invoke' with 'resume'. Then after resume, append the URL with /{{EXECUTION_ID}}. For example, if the API Endpoint is the following: {{< api_endpoint >}}/flo/5f023d66e31808a8ce04954078fabc99/invoke, the endpoint that will resume the Flow is {{< api_endpoint >}}/flo/5f023d66e31808a8ce04954078fabc99/resume/1234SampleExecutionID0987.

The execution ID for a given execution can be found in one of two places: 1. From the API Endpoint card itself - one of the default output fields for every monitor event is 'Execution ID'. This value can be used as an input to another card, that will allow you do something with this field down the line in the Flow. This might be a good method for programmatically resuming the Flow. 2.

The response from the request to the API endpoint will also include the Execution ID in the headers, so you can also retrieve this ID from the service that is originally calling the Flow.

Input Fields

Create a custom input field for each value you want passed to the caller when the Flow pauses.

Output Fields

Create a custom output field to correspond to each value that will be passed back to the Flow by the caller along with the resume request. To pass data to these output keys, submit them as JSON key value pairs in the body of the request. E.g. - If you have an output with the name 'foo', pass in "foo":"bar" to send 'bar' as the value to be returned by the foo output key.

See Also

Functions

About the elements of Okta Workflows