Wait for Events (Lookup) v1.0.0 Help ​

Waits for specified events in the Lookup system related to collection, document, or passage actions and triggers the Flow accordingly.

How can I use the Step? ​

This Step is useful when you want to trigger certain actions in your Flow based on specific events occurring in your Lookup system. For instance, you should initiate a process when a new document is added to a collection or when a passage within a document is updated or deleted.

How does the Step work? ​

The Step listens for specific events tied to collections, documents, or passages within the Lookup system. When an event that the Step is subscribed to occurs, the Step captures the event details and proceeds through the Flow.

Input settings ​

Configure the following parameters to set up the event listener:

  • Collection: the specific collection to monitor or leave blank to monitor all collections.
  • Collection actions: the collection actions to listen for (Create, Update, Delete).
  • Document: the specific documents to monitor within the chosen collection or leave blank to monitor all documents.
  • Document actions: the document actions to listen for (Create, Update, Delete).
  • Passage: the specific passages to monitor within the chosen documents or leave blank to monitor all passages.
  • Passage actions: the passage actions to listen for (Create, Update, Delete).
  • Use one exit: determines whether all events should exit the Step at the same point or have individual exits.

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 object contains details about the triggered event:

  • name: [string] the name of the event.
  • collectionId: [string] the ID of the collection involved in the event.
  • documentId: [string] the ID of the document involved in the event.
  • passageId: [string] the ID of the passage involved in the event.
  • passageIds: [array of strings] the IDs of passages involved in the event if multiple passages are affected.

Example:

json
{
  "name": "lookup/collection/create",
  "collectionId": "45fc9bbd-e5b1-40b7-bd82-5bd32fca020e",
  "documentId": "b57b5125-41ab-4425-801e-9c1b395e7f5c",
  "passageId": "9fc6909c-8fa7-4b4d-aec0-8c46fd760948",
  "passageIds": [
    "df37c693-806e-4ac5-a747-2201f23fcf2b",
    "9fc6909c-8fa7-4b4d-aec0-8c46fd760948"
  ]
}
{
  "name": "lookup/collection/create",
  "collectionId": "45fc9bbd-e5b1-40b7-bd82-5bd32fca020e",
  "documentId": "b57b5125-41ab-4425-801e-9c1b395e7f5c",
  "passageId": "9fc6909c-8fa7-4b4d-aec0-8c46fd760948",
  "passageIds": [
    "df37c693-806e-4ac5-a747-2201f23fcf2b",
    "9fc6909c-8fa7-4b4d-aec0-8c46fd760948"
  ]
}

Error handling ​

By default, the Step handles errors using a separate exit. So 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 ​

  • flow builder - v2.28.3
  • event-manager - v2.3.0
  • deployer - v2.6.0
  • library v2.11.3
  • studio v2.64.1

Release notes ​

v1.0.0

  • Initial release