v24

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-19169310464.0 KB
Flows

Dry-run a flow

Simulate this flow firing without storing events, enqueuing jobs, or consuming cooldown/rate-limit slots.

Works for every trigger activation type:

  • event: validates the payload against the event catalog schema and evaluates the trigger conditions.
  • custom: validates the payload against the custom payload schema (conditions do not apply).
  • schedule: ignores the payload and reports the next fire time.

The response reports wouldFire — whether the flow would actually run right now — alongside the gates that decide it (enabled, device attached, blocked, cooldown). rateLimited is informational and is not folded into wouldFire.

post/flows/{flowId}/dry-run

Path parameters

flowIdstring uuid required

Request body

payloadobject

Response

Dry-run result