When you Execute a Workflow using the Execute Workflow endpoint, you will always execute a specific version of that Workflow. By default, this will be the currently Deployed version, and your call will automatically point to the latest logic when any updates are Deployed.

However you can always specify a specific version of your Workflow to run. See Versions and Save, Version, Deploy for more details.

Dry Run Mode

Dry Run Mode is designed for testing your Workflows while minimizing cost and noise. In this mode

  1. Data connectors will use cached data from recent runs, to avoid making calls to any paid data vendors
  2. Executions are not saved to the History
  3. No alerts are generated
  4. Slack and Email notifications will be muted

Dry Run Mode is on by default when you test your workflows through the UI. However you can also add dryRun=true to the end of your API calls for the same effect. This is not recommended for any production API calls, only for testing.

Calling Workflows Asynchronously

For extremely time-sensitive usecases, you may want to trigger a workflow to run, and then check on the results later. To support this, we offer the async option on a workflow.

To trigger a workflow in this mode, simply add the parameter async=true to your API call, for example:

You'll receive a response with a result of "running", and an execution id.

    "flags": [],
    "warnings": [],
    "executionId": 1969,
    "result": "RUNNING",
    "dateEvaluated": "2021-11-17",
    "workflowId": 10,
    "workflowVersion": 612,

The workflow will continue to run, and upon completion you'll see the execution appear in the History tab, Alerts will be generated if appropriate, and Webhooks will fire as usual.

If you want to check the results of an API call later on, you can use the Resume Execution API endpoint, with the executionId returned from your initial workflow call.