Try API

Fire real events and execute published workflows from the dashboard to validate them end to end.

Try API runs a published workflow the way a production trigger would, so you can validate the full path (the trigger, the workflow, and its actions against the connected app) without waiting for a real event to arrive. Fire an event or execute a Workflow API trigger against a linked account, then check the result in Logs.

Try API is for exercising published workflows from the dashboard. To test a draft node by node while you build it, use Workflow Testing in the editor instead.

Try API works in both test and production environments.

Before you start

• The app is connected for the linked account you want to fire against.
• The workflow has an event or Workflow API trigger in its start node and is published.
• The workflow is enabled for that linked account.

Fire a trigger

Fire an event

1. Configure

   In Try API, select the linked account, choose the event, and specify the application the workflow belongs to. Optionally select a Config ID.

   If you don’t select an application, every workflow on the selected linked account that listens for the chosen event fires.

2. Fire

   Click Fire Event. The event triggers any matching workflows.

Execute a workflow

1. Open the Workflow tab

   Switch to the Workflow tab in Try API.

2. Configure

   Select the linked account, choose the workflow with a Workflow API trigger, and specify its application. Optionally select a Config ID, and toggle Synchronous Execution to return the result inline.

3. Execute

   Click Execute Workflow.

A fire or execution runs the workflow’s actions for real, making real API calls as the selected linked account. It can create or modify real records in the connected account. Use a test or sandbox account where possible.

Check the result

Every fire or execution is recorded. Open Logs and find the run in the Executions tab to step through each node’s input, output, and any errors.

See also

• Workflow Testing: test a draft node by node in the editor.
• Logs: inspect execution history and per-node output.
• Reliability: handle errors and rate limits in production.