Wait for Authorization in Dynamic Collection v1.0.0 Help ​

Pauses the Flow until a specific authorization in a dynamic collection is successful or fails.

How can I use the Step? ​

Use this Step to pause your Flow until an authorization in a dynamic collection either succeeds or fails. This is useful when you need to ensure that certain authorization processes are completed before proceeding with the Flow.

How does the Step work? ​

The Step waits for an event indicating the status of a specific authorization in a dynamic collection. It checks the specified collection and authorization key, pausing the Flow until it receives a success or failure status. If the authorization is successful, the Flow continues; if it fails or times out, the Flow exits or proceeds down the error path.

Dynamic collection settings ​

This section outlines the parameters for configuring the Step's interaction with dynamic collections:

  • Authorization source: Defines how the Step receives authorization information. You can inherit the dynamic collection name and authorization key from the previous Step or define them manually. Exception: The inheritance option doesn't work with the List Authorization in Dynamic Collection Step.
  • Dynamic collection name: The name of the dynamic collection to check.
  • Authorization key: The specific authorization key to wait for within the dynamic collection.

Timeout settings ​

  • Timeout duration: Sets the maximum time to wait for the authorization status before timing out.

Merge field settings ​

The Step returns the result as a JSON object and stores it under the Merge field name. To learn more about Merge fields and how to work with them, see our Merge fields guide.

Output example ​

The output JSON object will typically contain a message about the authorization status. For example:

json
{
  "message": "Authorization successful" // or "Authorization failed"
}
{
  "message": "Authorization successful" // or "Authorization failed"
}

Error Handling ​

By default, the Step handles errors using a separate exit. If any error occurs during the Step execution, the Flow proceeds down the error exit. For more information, see Error and timeout handling.

Reporting ​

The Step automatically generates Reporting events during its execution, allowing for real-time tracking and analysis of its performance and user interactions. To learn more, see Reporting events.

Service dependencies ​

  • sdk-api v2.17.0
  • access event-manager v2.1.0
  • oauth redirect endpoint provider v2.1.6

Release notes ​

v1.0.0

  • Initial release