The Wait for Message action pauses a flow until it receives a specific message from the sendMessage() Flow API. The flow remains in a waiting state until:
- A matching message is received, or
- A timeout occurs (if configured).
Example
Suppose a Change Request approval is rejected and requires additional information.
Ask for Approval -> Approval Rejected -> Wait for Message ("Resume Flow") -> Go back to Approval Step
sn_fd.FlowAPI.sendMessage(
contextId,
"Resume Flow",
"Resubmitted for approval"
);
Because the message text matches "Resume Flow", the flow resumes. The payload (Resubmitted for approval) is available as an output from the Wait for Message action and can be used later in the flow.
Think of it as the Flow Designer equivalent of the classic Workflow Wait for WF Event activity. Instead of polling or waiting for a condition, the flow pauses until sendMessage() sends the expected message.
