Documentation
Start typing to search…

Find Flow Run Detail

🧾 Definition

The “Find Flow Run Detail” action in the Zenphi category is designed to retrieve the execution details of a specific flow run within your workspace. This action returns a list of all steps executed during that run, including their statuses, execution timestamps, any associated error messages, and retry information.

It is particularly useful for auditing, debugging, and tracking the step-by-step progress of a flow instance. You can paginate the results if the number of steps is large, using the Page Size and Page Token fields.

Key Capabilities:

  • Retrieve complete execution details of a selected flow run.
  • Access detailed metadata for each step in the flow run.
  • Identify failed or retried steps, including the person who performed the retry.
  • Paginate large sets of step results for scalable inspection.
  • Useful for internal flow analytics and debugging workflows.

Example Use Cases

🔍 1. Debugging a Failed Flow Run

Use this action to retrieve detailed step-level execution information when a flow fails. It helps identify which step encountered an error and what the error message was, aiding quick resolution.

👣 2. Auditing Flow Execution

Review the steps taken in a specific flow run to ensure compliance with business or operational rules. Helpful for auditing approval flows, task assignments, or document routing steps.

📅 3. Monitoring Automated Processes

Track execution time and status of individual steps in a flow that automates recurring business processes, like onboarding, so you can identify slow or bottleneck steps.

🔁 4. Verifying Retried Actions

Check whether a step was retried, and who performed the retry (email and name). This is useful in flows where human intervention might be required to retry failed steps.

📊 5. Building Custom Logs or Reports

Use this action to extract structured data on all step executions, which can then be stored or visualized (e.g., in Zenphi tables or dashboards) for historical reporting or metrics.


🧩 Inputs

1. Flow Run Id

Provide the unique identifier of the flow run for which you want to retrieve step-level execution details.

**Details:**This ID is essential because each time a flow runs (manually or automatically), it generates a distinct Flow Run instance with its own data and execution path.

**How to get it:**You can retrieve the Flow Run ID dynamically from the “List Flow Runs” action or from tokens available in previous steps like “Read Flow Information”.

**Example:**If you want to investigate the steps in a flow run triggered yesterday, use “List Flow Runs” filtered by date and status, pick the Flow Run ID, and pass it here.

2. Page Size

Set the maximum number of step records to return in one page of the response. Must be between 1 and 500.

**Why it's useful:**If your flow has a large number of steps or complex branches, this input helps control the data volume returned, improving performance and readability.

**Example:**Set this to 100 if your flow typically has fewer than 100 steps and you want to fetch all in one call.

3. Page Token

If your result set is too large and spans multiple pages, use the page token from a previous response to retrieve the next page of step data.

**When to use:**Only needed when the response includes a Next Page Token, indicating there are more results to be fetched.

**Example:**After retrieving the first 100 steps, if your response includes a token, provide it here in the next call to continue retrieving the remaining steps.


🧩 Outputs

1. Next Page Token

This token is used to fetch the next set of results when the total number of steps in the flow run exceeds the current page size. If the response includes this token, it means there are additional pages of step details available.

**How it helps:**It allows you to paginate through large datasets, ensuring you can retrieve all step details without overwhelming the system or the response size limits.

**When empty:**If this field is empty, it means all steps for the flow run have been retrieved and no further requests are needed.

2. Steps (List of Step Information)

A list containing detailed information about each step executed within the specified flow run. Each item in the list represents a step and includes several important fields:

  • StatusThe current state of the step, such as Succeeded, Failed, Running, or Skipped. This indicates whether the step completed successfully or encountered issues during execution.

  • Start TimeThe precise timestamp marking when the step began execution. Useful for tracking step duration and performance analysis.

  • Finish TimeThe exact timestamp of when the step completed. Combined with start time, it helps calculate the duration and timing of each step.

  • NameThe internal name identifier of the step within the flow. This is typically a system-generated unique identifier for reference.

  • Display NameThe human-readable name assigned to the step in the flow designer. This is what users typically see and helps identify the step easily.

  • Error MessageIf the step encountered any error, this field contains the detailed error message or exception information. Essential for debugging and understanding why a step failed.

  • RetriedA boolean flag indicating whether this step was retried during the flow run. This helps identify if errors were automatically or manually handled by rerunning the step.

  • Retried By EmailIf the step was retried manually, this field shows the email address of the user who triggered the retry action. Useful for auditing and accountability.

  • Retried By NameThe full name of the user who retried the step, giving more context about who initiated the retry within the team or organization.

Summary

Together, these outputs provide comprehensive visibility into the execution details of every step within a flow run — from status and timing to error handling and retries. This helps administrators and users monitor performance, troubleshoot issues, and audit execution history with precision and clarity.


Example Situation: Troubleshooting a Failed Flow Run

Imagine you have an automated approval process running in Zenphi, where several steps are involved — like checking inputs, sending approval emails, and updating records. One day, a flow run fails, but you’re not sure which step caused the failure or why.

How to use "Find Flow Run Detail" here:

  1. Get the flow run ID from the "List Flow Runs" action to identify the specific instance of the flow that failed.
  2. Use the "Find Flow Run Detail" action, providing this flow run ID, to retrieve detailed information about each step in that run.
  3. Review the output steps, checking the status and error message fields to pinpoint exactly which step failed and what error was encountered.
  4. See if the step was retried and who retried it, to understand if attempts were made to fix the issue.
  5. Based on these details, you can quickly diagnose the problem, notify the responsible team, or even trigger a recovery workflow.

Updated about 4 hours ago