runFlow
Manually run an automation for a specific customer/conversation context, bypassing its normal trigger — useful for testing a draft or invoking a flow on demand (e.g. from a support tool).
Resolves a starting point from automationNs (uses its startNodeNs) or
directly from nodeNs (looks up its parent automation); at least one is
required. Runs against the automation’s draft nodes when the resolved
automation is currently a draft, otherwise its live nodes.
Errors: يجب تحديد معرف الأتمتة (automationNs, nodeNs) when neither is provided; Automation not found; Automation has no start node configured; Node not found.
Auth · x-app-token · required permission automationsEdit
Related: automationDetail, automationHistories, Authentication
runFlow(automationNs: String, nodeNs: String, conversationId: String, integrationId: String, customer: CustomerInput, payload: JSON): JSONArguments
Automation to run, starting at its startNodeNs. Required unless nodeNs is given.
Specific node to start execution at, instead of the automation's default start node.
Conversation id to bind the run to, when applicable.
Integration id to bind the run to, when applicable.
Customer context for the run — matched by _id, code, phone, or email (first match wins), or used as-is if none match.
Arbitrary JSON payload made available to the flow as trigger data.