whatsapp_business_messaging permission in your App Dashboardresponse_json field contains Flow-specific data whose structure is controlled by the Flow JSON or, for endpoint-powered Flows, by the final response payload from the endpoint.flow_token field to identify the corresponding Flow.{ "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 |
|---|---|
contextobject | Context of the message that the user replied to. Context object contains message_id of flows request message and sender number. |
context.fromstring | User’s WhatsApp account number |
context.idstring | Message ID |
context.typestring | Always interactive |
interactive.typestring | Always nfm_reply |
interactive.nfm_reply.namestring | flow |
interactive.nfm_reply.bodystring | Always Sent |
interactive.nfm_reply.response_jsonstring | 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) |
timestampstring | Time of flow response message |
| Name | Description |
|---|---|
objectstring | The webhook a business has subscribed to |
entryarray of objects | An array of entry objects. Entry objects have the following properties:
|
changes array of the entry array.| Name | Description |
|---|---|
flow_idstring | ID of the flow |
thresholdnumber | The alert threshold that was reached or recovered from |
eventstring | Type of webhook notification sent, value being one of:
|
messagestring | Detailed message describing webhook |
old_statusstring | Previous status of the flow, value being one of:
|
new_statusstring | Previous status of the flow, value being one of:
|
alert_statestring | Status of the alert, value being one of:
|
requests_countinteger | Number of requests used to calculate metric |
errorsarray of objects | An array of error objects describing each error included in the alert. Error objects have the following properties:
|
p50_latencyinteger | P50 latency of the endpoint requests |
p90_latencyinteger | P90 latency of the endpoint requests |
error_rateinteger | Overall error rate for the alert |
Published, Throttled, Blocked or Deprecated.{ "entry": [ { "id": "644600416743275", "time": 1684969340, "changes": [ { "value": { "event": "FLOW_STATUS_CHANGE", "message": "Flow Webhook 3 changed status from DRAFT to PUBLISHED", "flow_id": "6627390910605886", "old_status": "DRAFT", "new_status": "PUBLISHED" }, "field": "flows" } ] } ], "object": "whatsapp_business_account" }
Draft as a default status.{ "entry": [ { "id": "644600416743275", "time": 1684969340, "changes": [ { "value": { "event": "FLOW_STATUS_CHANGE", "message": "Flow Webhook 3 has been created with DRAFT status", "flow_id": "6627390910605886", "new_status": "DRAFT" }, "field": "flows" } ] } ], "object": "whatsapp_business_account" }
{ "entry": [ { "id": "106181168862417", "time": 1674160476, "changes": [ { "value": { "event": "CLIENT_ERROR_RATE", "message": "The flow client request error rate has reached the 5% threshold in the last 60 minutes. A higher error rate will make it harder for users to complete the flow, resulting in drop-offs.", "flow_id": "691244242662581", "error_rate": 14.28, "threshold": 10, "alert_state": "ACTIVATED", "errors": [ { "error_type": "INVALID_SCREEN_TRANSITION", "error_rate": 66.66, "error_count": 2 }, { "error_type": "PUBLIC_KEY_MISSING", "error_rate": 33.33, "error_count": 1 }, ], }, "field": "flows" } ] } ], "object": "whatsapp_business_account" }
{ "entry": [ { "id": "106181168862417", "time": 1674160476, "changes": [ { "value": { "event": "ENDPOINT_ERROR_RATE", "message": "The flow endpoint request error rate has reached the 10% threshold in the last 30 minutes. A higher error rate will make it harder for users to complete the flow, resulting in drop-offs.", "flow_id": "691244242662581", "error_rate": 14.28, "threshold": 10, "alert_state": "ACTIVATED", "errors": [ { "error_type": "CAPABILITY_ERROR", "error_rate": 66.66, "error_count": 2 }, { "error_type": "TIMEOUT", "error_rate": 33.33, "error_count": 1 }, ], }, "field": "flows" } ] } ], "object": "whatsapp_business_account" }
{ "entry": [ { "id": "106181168862417", "time": 1674160476, "changes": [ { "value": { "event": "ENDPOINT_LATENCY", "message": "Flow endpoint latency has reached the p90 threshold in the last 30 minutes. High latency will increase the loading time between screens in the flow, impacting user experience.", "flow_id": "691244242662581", "p90_latency": 8000, "p50_latency": 500, "requests_count": 34, "threshold": 7000, "alert_state": "ACTIVATED", }, "field": "flows" } ] } ], "object": "whatsapp_business_account" }
{ "entry": [ { "id": "106181168862417", "time": 1674160476, "changes": [ { "value": { "event": "ENDPOINT_AVAILABILITY", "message": "The flow endpoint availability has breached the 90% threshold in the last 10 minutes. Users will be unable to open or use the flow.", "flow_id": "12345678", "alert_state: "ACTIVATED", "availability": 75, "threshold" : 90, }, "field": "flows" } ] } ], "object": "whatsapp_business_account" }
{ "entry": [ { "id": "644600416743275", "time": 1684969340, "changes": [ { "value": { "event": "FLOW_STATUS_CHANGE", "message": "Flow Webhook 3 has been created with DRAFT status", "flow_id": "6627390910605886", "new_status": "DRAFT" "warning": "Your current Flow version will freeze in 21 days. You won't be able to send the Flow after it expires. Please migrate to the recommended version as soon as possible. /documentation/business-messaging/whatsapp/flows/changelogs#currently-supported-versions" }, "field": "flows" } ] } ], "object": "whatsapp_business_account" }
{ "entry": [ { "id": "644600416743275", "time": 1684969340, "changes": [ { "value": { "event": "FLOW_VERSION_EXPIRY_WARNING", "warning": "Your current Flow version will freeze in 21 days. You won't be able to send the Flow after it expires. Please migrate to the recommended version as soon as possible. /documentation/business-messaging/whatsapp/flows/changelogs#currently-supported-versions" "flow_id": "6627390910605886", }, "field": "flows" } ] } ], "object": "whatsapp_business_account" }