Handling Flow submission

Once your customer has completed a WhatsApp Flow this will be received as a new message on the WhatsApp channel that the WhatsApp Flow message template was sent on.

The message body for a WhatsApp Flow submission will always be as follows:

"body": {
    "type": "text",
    "text": {
      "text": "The customer has completed a WhatsApp flow"
    }
  }

As an example in Inbox you will always see the following:

In addition the message will contain a jsonResponse object in the meta.formResponse object of the message. You can use the jsonResponse in a Bird Flow to update contact information or an external source.

"meta": {
    "extraInformation": {
      "timestamp": "1721065205"
    },
    "formResponse": {
      "id": "00000000-0000-0000-0000-000000000000",
      "sessionIdentifier": "00000000-0000-0000-0000-000000000000",
      "requestIdentifier": "00000000-0000-0000-0000-000000000000",
      "jsonResponse": {
        "flow_token": "12345",
        "exampletext": "usefultext",
        "data": "usefuldata"
      }
    }
  }

Last updated

Was this helpful?