Reply flows

​

How a reply flow runs

1. Create a reply flow revision with the Messaging API (Create project campaign reply flow) or the Platform API (Create campaign reply flow).
2. Attach it to a draft or scheduled campaign (Messaging, Platform).
3. When a campaign message is sent, the flow starts for that recipient on the entry step, which sends nothing and waits for the first reply.
4. A reply that matches one of the step’s branches moves the recipient to the next step, which sends its message. A reply that matches nothing is ignored.

​

Limits

​

Branches

• choice: the recipient tapped a reply button (replyKind: "button") or a list row (replyKind: "list") with this id. A step that sends buttons or a list can branch only on the choices it offers.
• keyword: the reply text equals this keyword, ignoring case. A reply that quotes the step’s message always counts. An unquoted reply counts only when this is the recipient’s only waiting flow and no other campaign message reached them since the step’s message. Built-in STOP and START words cannot be flow keywords.
• flow_submission: the recipient submitted the Flow form this step sent. Polymorfa does not store the form answers.

​

Messages a step can send

​

Example

{
  "name": "Order help",
  "definition": {
    "entryNodeId": "start",
    "nodes": [
      { "id": "start", "edges": [{ "match": { "kind": "keyword", "value": "help" }, "to": "menu" }] },
      {
        "id": "menu",
        "send": {
          "kind": "buttons",
          "body": "What do you need help with?",
          "buttons": [{ "id": "track", "text": "Track order" }, { "id": "return", "text": "Return" }]
        },
        "edges": [
          { "match": { "kind": "choice", "replyKind": "button", "id": "track" }, "to": "track" },
          { "match": { "kind": "choice", "replyKind": "button", "id": "return" }, "to": "return" }
        ]
      },
      { "id": "track", "send": { "kind": "text", "text": "Reply with your order number." }, "edges": [] },
      { "id": "return", "send": { "kind": "text", "text": "Start your return at example.com/returns." }, "edges": [] }
    ]
  }
}