Response Message Webhook
When user completes the flow, a message is sent to WhatsApp chat. You will receive that message through a webhook which you normally use to process chat messages from the user. Below is the structure of flow response message webhook payload:
{
"messages": [{
"context": {
"from": "16315558151",
"id": "gBGGEiRVVgBPAgm7FUgc73noXjo"
},
"from": "<USER_ACCOUNT_NUMBER>",
"id": "<MESSAGE_ID>",
"type": "interactive",
"interactive": {
"type": "nfm_reply",
"nfm_reply": {
"name": "flow",
"body": "Sent",
"response_json": "{\"flow_token\": \"<FLOW_TOKEN>\", \"optional_param1\": \"<value1>\", \"optional_param2\": \"<value2>\"}"
}
},
"timestamp": "<MESSAGE_SEND_TIMESTAMP>"
}]
}| Parameter | Description |
|---|---|
| Context of the message that the user replied to. Context object contains message_id of flows request message and sender number. |
| User's WhatsApp account number |
| Message ID |
| Always |
| Always |
|
|
| Always |
| Flow-specific data. The structure is either defined in flow JSON (see Complete action) or, if flow is using an endpoint, controlled by endpoint (see Final Response Payload in Data Exchange Request) |
| Time of flow response message |