Pause

This function card pauses a flow and returns the inputs using the interface that initiated the flow, along with the Execution ID of the flow that 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 need to resume. The endpoint is similar to the one that invokes the flow. Find the endpoint on the API Endpoint card's Event Settings page. But you must replace invoke with resume. Then after you resume the flow, 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:

  • API Endpoint card: One of the default output fields for every monitor event is Execution ID. This value can be used as an input to another card. This might be a good method for programmatically resuming the flow.

  • Response from the request to the API endpoint: This also includes the Execution ID in the headers, so you can also retrieve this ID from the service that is originally calling the flow.

The Pause function card 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 card.

Input

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

Output

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. For example, if you have an output with the name X, pass in X:Y to send Y as the value to be returned by the X output key.

Related topics

Functions in Workflows

About the elements of Okta Workflows