REreacherapp
Workflows

Simulate a workflow

Changed on

Walk a definition over imaginary creators for days simulated days and return each one's path, the messages they would have received, and per-step counts. Nothing is written and nothing is sent. Supply scenario.creators to script specific attributes and events, or omit it for a default cast.

post/workflows/dry-run

Request

  • Base URL
    https://api.reacherapp.com/public/v1
  • URL
    https://api.reacherapp.com/public/v1/workflows/dry-run
  • Auth
    API key in header x-api-key and API key in header x-shop-id

Request body

definitionobject required

The workflow document: name, a trigger and its steps. Validated strictly on the way in. GET /workflows/templates returns working examples, GET /workflows/conditions the rule vocabulary for this shop, and POST /workflows/validate reports what is wrong with one.

settingsobject nullable

Exclusions (groups, lists, blacklist), dailyMessageLimits and dailyInviteLimits keyed by weekday, skipCreatorsInOtherWorkflows, and timezone — which decides when the daily budget resets.

scenarioobject nullable

{"creators": [{name, attributes, events}]} to script the cast, up to 50. Omit for a default cast of imaginary creators.

daysinteger

Simulated days to walk.

tick_hoursinteger

Simulated hours between runtime ticks.

Response

Successful Response

Changes