Webhook events and notifications

Partner Webhook Events (associated with Partner API)

Real-time notifications sent to your Partner Webhook about the management of WABAs and phone numbers associated with your Partner Account.

After your Partner Hub Webhook URL is configured, you will start receiving these Webhook events.

The events shared today are:

Client Account created

This event is submitted to a partner's webhook when a new client registers under their hub.

The field event will have client_created value set.

Example payload

Channel created

This event is triggered every time a new channel is created under your 360dialog Partner Hub. This is the first event created after the client finishes signup.

The field event will have channel_created value set.

You will be able to identify which client created this channel in the client_id and client fields. You are also able to see the phone number (phone_number field) and display name (phone_name field) registered in this channel.

Under the field created_at you can see when was the account created and under billing_started_at you can see when the billing started.

You can also see the current Business Manager status of this account under fb_account_status and the account status under status and account_mode.

Example payload

Channel ready

This event is submitted to a partner's webhook when a number is ready to be registered.

Field event will have channel_ready value set.

Example Payload

Channel running

This event is submitted to a partner's webhook when a new number transitions into running state.

Field event will have channel_running value set.

Example Payload

Channel live

This event is triggered every time a new channel submitted under your 360 Partner Hub goes live.

The field event will have channel_live value set.

You will be able to identify which client created this channel in the client_id and client fields. You are also able to see the phone number (phone_number field) and display name (phone_name field) registered in this channel.

Under the field created_at you can see when was the account created and under billing_started_at you can see when the billing started.

You can also see the current Business Manager status of this account under fb_account_status and the account status under status and account_mode.

Example payload

Channel permission granted

This event is triggered every time a client grants permission for their number, meaning that you can now request the API Key for this specific channel.

The field event will have channel_permission_granted value set.

You will be able to identify which client created this channel in the client_id and client fields. You are also able to see the phone number (phone_number field) and display name (phone_name field) registered in this channel.

Example payload

Channel permission revoked

This event is triggered every time a client revokes permission for their number.

The field event will have channel_permission_revoked value set.

You will be able to identify which client created this channel in the client_id and client fields. You are also able to see the phone number (phone_number field) and display name (phone_name field) registered in this channel.

Example payload

Channel subscription was set

This event is triggered when a channel subscription is set, meaning when the billing starts for this channel.

The field event will have channel_subscription_set value set.

You will be able to identify which client created this channel in the client_id and client fields. You are also able to see the phone number (phone_number field) and display name (phone_name field) registered in this channel.

Example payload

Cancellation request

This event is triggered every time a client requests a channel cancellation.

The field event will have cancellation_request value set.

You will be able to identify which client created this channel in the client_id and client fields. You are also able to see the phone number (phone_number field) and display name (phone_name field) registered in this channel.

Example payload

Cancellation revoked

This event is triggered every time a client revokes a channel cancellation.

The field event will have cancellation_revoke value set.

You will be able to identify which client created this channel in the client_id and client fields. You are also able to see the phone number (phone_number field) and display name (phone_name field) registered in this channel.

Example payload

Cancellation processed

This event is triggered every time a client cancellation request is processed and the phone number is deleted.

The field event will have cancellation_processed value set.

You will be able to identify which client created this channel in the client_id and client fields. You are also able to see the phone number (phone_number field) and display name (phone_name field) registered in this channel.

Example payload

Channel enabled for template messaging

Right after signup, after the channel is live, it is temporarily disabled for template message sending. Each channel goes through internal 360dialog review and, if valid, will have template messaging enabled in up to 2 hours.

When a channel is enabled for template messaging, the partner will receive this event.

Field event will have template_messaging_enabled value set.

Example payload

Hosting platform type change

This event is submitted when the hosting platform type changes.

Field event will have either migrated_to_cloud_api or migrated_to_on_premise value set if there was migration from On-premise to Cloud API or vice versa.

Example payload

As announced in November 2023, Meta is transitioning to a fully Cloud-hosted WhatsApp Business Platform and will stop supporting On-Premise API in October 2025.

Starting from On-Premise client v2.53, all new feature updates will be exclusively delivered to Cloud API. While the On-Premise API client will receive quarterly releases, they will focus solely on bug fixes and security patches. From May 15, 2024, 360dialog will not allow for new numbers to be onboarded with On-Premise API. We will continue supporting already registered On-Premise API throughout 2024, but we strongly recommend to start changing the hosting type of numbers to Cloud as soon as possible. Learn here how to integrate with Cloud API.

Account violation

This event is submitted to a partner's webhook when a client's account is restricted.

The field event will have account_violation value set.

You will be able to identify which account was restricted by the value phone_number. There will also be violation_type, which indicates what made the account be restricted.

Example payload

Account banned

This event is submitted to a partner's webhook when a client's account is banned.

The field event will have DISABLED_UPDATE value set.

Example payload
{
      "id": "string",
      "event": "DISABLED_UPDATE",
      "data": {
        "id": "string",
        "setup_info": {
          "phone_number": "string",
          "phone_name": "string"
        },
        "status": "string",
        "account_mode": "live",
        "created_at": "string",
        "billing_started_at": null,
        "cancelled_at": null,
        "terminated_at": null,
        "client_id": "string",
        "current_quality_rating": null,
        "current_limit": null,
        "has_inbox": false,
        "is_oba": false,
        "hub_status": "string",
        "version": 1,
        "is_migrated": false,
        "settings": null,
        "client": {
          "id": "string",
          "name": "0",
          "contact_info": {},
          "partner_payload": null
        },
        "waba_account": {
          "id": "string",
          "on_behalf_of_business_info": null,
          "fb_account_status": "string",
          "namespace": null,
          "external_id": "string",
          "fb_business_id": "string"
        }
      }
    }

Account restriction

This event is submitted to a partner's webhook when a client's account is restricted.

The field event will have account_restriction value set.

You will be able to identify which account was restricted by the value phone_number. There will also be violation_type, which indicates what made the account be restricted.

Example payload

Quality-rating event

This event is submitted to a partner's webhook when numbers quality rating changes and we receive a callback from Meta.

Field event will have phone_number_quality_changed value set. Also in data object, there will be an extra property called current_quality_update_event to tell the type of event received from FB. Examples of events are flagged, etc.

Example payload

Message Template Status Update

A template status can change automatically, based on a review decision, appeal outcome, or a change to its quality rating. Webhooks are sent with the following structure:

{
  "id": "string",
  "event": "string",
  "data": {
    "id": "string",
    "setup_info": {
      "phone_number": "string",
      "phone_name": "string"
    },
    "status": "string",
    "account_mode": "string",
    "created_at": "string",
    "billing_started_at": "string",
    "cancelled_at": "null",
    "terminated_at": "null",
    "client_id": "string",
    "current_quality_rating": "string",
    "current_limit": "string",
    "has_inbox": "boolean",
    "is_oba": "boolean",
    "hub_status": "string",
    "version": "number",
    "is_migrated": "boolean",
    "settings": {
      "tier": "string"
    },
    "client": {
      "id": "string",
      "name": "string",
      "contact_info": {
        "email": "string",
        "country": "string",
        "street_name": "string"
      },
      "partner_payload": "null"
    },
    "waba_account": {
      "id": "string",
      "on_behalf_of_business_info": {
        "id": "string",
        "name": "string",
        "type": "string",
        "status": "string"
      },
      "fb_account_status": "string",
      "namespace": "string",
      "external_id": "string",
      "fb_business_id": "string"
    },
    "integration": {
      "enabled": "boolean",
      "state": "string",
      "app_id": "string",
      "hosting_platform_type": "string"
    },
    "template": { //template payload
    }
  }
}

The template payload structure depends on the type of the template update:

Template Quality Score Changed

The field event will have waba_template_quality_score_changed value set. See Quality Rating.

Example payload
"template": {
            "id": "<template_id>",
            "external_id": "<external_id>",
            "name": "<name>",
            "previous_quality_score": "<old_quality>",
            "new_quality_score": "<new_quality>",
            "language": "<language>",
        }

Template Status Changed

The field event will have waba_template_status_changed value set. See Template Statuses.

Example payload
"template": {
      "id": "<template_id>",
      "external_id": "<external_id>",
      "name": "<name>",
      "new_status": "<new_status>",
      "language": "<language>",
      "rejected_reason": "<rejected_reason>",
      "other_info": "<other_info>"
    }

The status of the message template can be: APPROVED, IN_APPEAL, PENDING, REJECTED, PENDING_DELETION, DELETED, DISABLED, PAUSED, LIMIT_EXCEEDED.

The rejection_reason can be: ABUSIVE_CONTENT, INVALID_FORMAT, NONE, PROMOTIONAL, TAG_CONTENT_MISMATCH, SCAM

Template Category Changed

The field event will have waba_template_category_changed value set. See Template Categories.

Example payload
"template": {
            "id": "<template_id>",
            "external_id": "<external_id>",
            "name": "<name>",
            "previous_category": "<old_category">,
            "new_category": "<new_category>",
            "language": "<language>"
        }

Flow endpoint availability event

This event is submitted to partner's webhook when flow's endpoint availability reaches the threshold.

Field event will have ENDPOINT_AVAILABILITY value set.

Example Payload

Flow client error rate event

This event is submitted to partner's webhook when flow's client error rate reaches the threshold.

Field event will have CLIENT_ERROR_RATE value set.

Example Payload

Flow endpoint error rate event

This event is submitted to partner's webhook when flow's endpoint error rate reaches the threshold.

Field event will have ENDPOINT_ERROR_RATE value set.

Example Payload

Flow endpoint latency event

This event is submitted to partner's webhook when flow's endpoint latency reaches the threshold.

Field event will have ENDPOINT_LATENCY value set.

Example Payload

Flow status change event

This event is submitted to partner's webhook when flow's status is changed.

Field event will have FLOW_STATUS_CHANGE value set.

Example Payload

Messaging Webhook (associated with Messaging API)

After the webhook is set for the number, it will receive notifications about messaging events. These events are grouped and can be used for:

  • Inbound Message Notifications: Use it to get a notification when a customer performs an action, such as:

  • Sends a text message to the business

  • Sends an image, video, audio, document, or sticker to the business

  • Sends contact information to the business

  • Sends location information to the business

  • Clicks a reply button set up by the business

  • Clicks a call-to-actions button on an Ad that Clicks to WhatsApp

  • Clicks an item on a business' list

  • Updates their profile information such as their phone number

  • Asks for information about a specific product

  • Orders products being sold by the business

Message Status Notifications: Use it to monitor the status of sent messages.

  • delivered

  • read

  • sent

If a webhook event isn't delivered for any reason (e.g., the client is offline) or if the webhook request returns a HTTP status code other than 200, we retry the webhook delivery. We continue retrying delivery with increasing delays up to a certain timeout (typically 24 hours, though this may vary), or until the delivery succeeds.

For Cloud API, the object is always whatsapp_business_account but the field will be indicative of the type of information being sent.

{
  "object": "whatsapp_business_account",
  "entry": [{
    "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
    "changes": [{
      "value": {
        "messaging_product": "whatsapp",
        "metadata": {
          "display_phone_number": PHONE_NUMBER,
          "phone_number_id": PHONE_NUMBER_ID
        },
        "contacts": [{
          "profile": {
            "name": "NAME"
          },
          "wa_id": PHONE_NUMBER
        }],
        "messages": [{
          "from": PHONE_NUMBER,
          "id": "wamid.ID",
          "timestamp": TIMESTAMP,
          "text": {
            "body": "MESSAGE_BODY"
          },
          "type": "text"
        }]
      },
      "field": "messages"
    }]
  }]
}

[will be deprecated] For On-premise API, the object will be contacts and messages, errors, or statuses and pricing.

{
  "contacts": [{
    "profile": {
      "name": "NAME"
    },
    "wa_id": "WHATSAPP_BUSINESS_ACCOUNT_ID"
  }],
  "messages":[{
    "from": "PHONE_NUMBER",
    "id": "wamid.ID",
    "timestamp": "TIMESTAMP",
    "text": {
      "body": "MESSAGE_BODY"
    },
    "type": "text"
  }]
} 

Text Messages

See Text Messages.

The following is an example of a text message you received from a customer:

Example Payload
{
  "object": "whatsapp_business_account",
  "entry": [{
      "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
      "changes": [{
          "value": {
              "messaging_product": "whatsapp",
              "metadata": {
                  "display_phone_number": PHONE_NUMBER,
                  "phone_number_id": PHONE_NUMBER_ID
              },
              "contacts": [{
                  "profile": {
                    "name": "NAME"
                  },
                  "wa_id": PHONE_NUMBER
                }],
              "messages": [{
                  "from": PHONE_NUMBER,
                  "id": "wamid.ID",
                  "timestamp": TIMESTAMP,
                  "text": {
                    "body": "MESSAGE_BODY"
                  },
                  "type": "text"
                }]
          },
          "field": "messages"
        }]
  }]
}

Reaction Messages

See Reaction Messages.

The following is an example of a reaction message you received from a customer. You will not receive this webbook if the message the customer is reacting to is more than 30 days old.

Example Payload
{
"object": "whatsapp_business_account",
"entry": [{
    "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
    "changes": [{
        "value": {
            "messaging_product": "whatsapp",
            "metadata": {
                "display_phone_number": PHONE_NUMBER,
                "phone_number_id": PHONE_NUMBER_ID
            },
            "contacts": [{
                "profile": {
                  "name": "NAME"
                },
                "wa_id": PHONE_NUMBER
              }],
            "messages": [{
                "from": PHONE_NUMBER,
                "id": "wamid.ID",
                "timestamp": TIMESTAMP,
                "reaction": {
                  "message_id": "MESSAGE_ID",
                  "emoji": "EMOJI"
                },
                "type": "reaction"
              }]
        },
        "field": "messages"
      }]
}]
}

Note that for reactions, the timestamp value indicates when the customer sent the reaction, not when the webhook was generated.

Media Messages

See Media Messages.

When a message with media is received, the WhatsApp Business Platform downloads the media. A notification is sent to the Webhook once the media is downloaded.

The Webhook notification contains information that identifies the media object and enables you to find and retrieve the object. Use the media endpoints to retrieve the media.

Example Payload
{
  "object": "whatsapp_business_account",
  "entry": [{
      "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
      "changes": [{
          "value": {
              "messaging_product": "whatsapp",
              "metadata": {
                  "display_phone_number": PHONE_NUMBER,
                  "phone_number_id": PHONE_NUMBER_ID
              },
              "contacts": [{
                  "profile": {
                    "name": "NAME"
                  },
                  "wa_id": "WHATSAPP_ID"
                }],
              "messages": [{
                  "from": PHONE_NUMBER,
                  "id": "wamid.ID",
                  "timestamp": TIMESTAMP,
                  "type": "image",
                  "image": {
                    "caption": "CAPTION",
                    "mime_type": "image/jpeg",
                    "sha256": "IMAGE_HASH",
                    "id": "ID"
                  }
                }]
          },
          "field": "messages"
        }]
    }]
}

When you receive a sticker, you will get the following notification:

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "ID",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "PHONE_NUMBER",
              "phone_number_id": "PHONE_NUMBER_ID"
            },
            "contacts": [
              {
                "profile": {
                  "name": "NAME"
                },
                "wa_id": "ID"
              }
            ],
            "messages": [
              {
                "from": "SENDER_PHONE_NUMBER",
                "id": "wamid.ID",
                "timestamp": "TIMESTAMP",
                "type": "sticker",
                "sticker": {
                  "mime_type": "image/webp",
                  "sha256": "HASH",
                  "id": "ID"
                }
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

Unknown Messages

It's possible to receive an unknown message callback notification. For example, a customer could send you a message that's not supported, such as a disappearing message (in which case Meta notifies the that the message type is not supported).

Example Payload

The following is an example of a message you received from a customer that is not supported.

{
  "object": "whatsapp_business_account",
  "entry": [{
      "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
      "changes": [{
          "value": {
              "messaging_product": "whatsapp",
              "metadata": { 
                "display_phone_number": "PHONE_NUMBER", 
                "phone_number_id": "PHONE_NUMBER_ID" 
              },
              "contacts": [{
                  "profile": { 
                    "name": "NAME" 
                  }, 
                  "wa_id": "WHATSAPP_ID"
                }],
              "messages": [{
                  "from": "PHONE_NUMBER",
                  "id": "wamid.ID", 
                  "timestamp": "TIMESTAMP",
                  "errors": [ 
                    { 
                      "code": 131051, 
                      "details": "Message type is not currently supported",
                      "title": "Unsupported message type"
                    }],
                   "type": "unknown"
                   }]
            }
            "field": "messages"
        }],
    }]
}

Location Messages

See Location Messages.

The following is an example of a location message you received from a customer:

Example Payload
{
  "object": "whatsapp_business_account",
  "entry": [{
      "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
      "changes": [{
          "value": {
              "messaging_product": "whatsapp",
              "metadata": {
                  "display_phone_number": "PHONE_NUMBER",
                  "phone_number_id": "PHONE_NUMBER_ID"
              },
              "contacts": [{
                  "profile": {
                    "name": "NAME"
                  },
                  "wa_id": "WHATSAPP_ID"
                }],
              "messages": [{
                  "from": "PHONE_NUMBER",
                  "id": "wamid.ID",
                  "timestamp": "TIMESTAMP",
                 "location": {
                    "latitude": LOCATION_LATITUDE,
                    "longitude": LOCATION_LONGITUDE,
                    "name": LOCATION_NAME,
                    "address": LOCATION_ADDRESS,
                 }
                }]
          },
          "field": "messages"
        }]
    }]
}

Contacts Messages

See Contacts Messages.

The following is an example of a contact message you received from a customer:

Example Payload
{
  "object":"whatsapp_business_account",
  "entry":[{
    "id":"WHATSAPP_BUSINESS_ACCOUNT_ID",
    "changes":[{
      "value":{
        "messaging_product":"whatsapp",
        "metadata": {
          "display_phone_number":"PHONE_NUMBER",
          "phone_number_id":"PHONE_NUMBER_ID"
          },
        "contacts": [{
          "profile":{
            "name":"NAME"
            },
          "wa_id":"WHATSAPP_ID"
          }],
        "messages":[{
          "from":"PHONE_NUMBER",
          "id":"wamid.ID",
          "timestamp":"TIMESTAMP",
          "contacts":[{
            "addresses":[{
              "city":"CONTACT_CITY",
              "country":"CONTACT_COUNTRY",
              "country_code":"CONTACT_COUNTRY_CODE",
              "state":"CONTACT_STATE",
              "street":"CONTACT_STREET",
              "type":"HOME or WORK",
              "zip":"CONTACT_ZIP"
            }],
            "birthday":"CONTACT_BIRTHDAY",
            "emails":[{
              "email":"CONTACT_EMAIL",
              "type":"WORK or HOME"
              }],
            "name":{
              "formatted_name":"CONTACT_FORMATTED_NAME",
              "first_name":"CONTACT_FIRST_NAME",
              "last_name":"CONTACT_LAST_NAME",
              "middle_name":"CONTACT_MIDDLE_NAME",
              "suffix":"CONTACT_SUFFIX",
              "prefix":"CONTACT_PREFIX"
              },
            "org":{
              "company":"CONTACT_ORG_COMPANY",
              "department":"CONTACT_ORG_DEPARTMENT",
              "title":"CONTACT_ORG_TITLE"
              },
            "phones":[{
              "phone":"CONTACT_PHONE",
              "wa_id":"CONTACT_WA_ID",
              "type":"HOME or WORK>"
              }],
            "urls":[{
              "url":"CONTACT_URL",
              "type":"HOME or WORK"
              }]
            }]
          }]
        },
      "field":"messages"
    }]
  }]
}

Received Callback from a Quick Reply Button

See Interactive Messages.

When your customer clicks on a quick reply button in an interactive message template, a response is sent. Below is an example of the callback format.

Example Payload
{
  "object": "whatsapp_business_account",
  "entry": [{
      "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
      "changes": [{
          "value": {
              "messaging_product": "whatsapp",
              "metadata": {
                  "display_phone_number": PHONE_NUMBER,
                  "phone_number_id": PHONE_NUMBER_ID
              },
              "contacts": [{
                  "profile": {
                    "name": "NAME"
                  },
                  "wa_id": "WHATSAPP_ID"
                }],
              "messages": [{
                  "context": {
                    "from": PHONE_NUMBER,
                    "id": "wamid.ID"
                  },
                  "from": "16315551234",
                  "id": "wamid.ID",
                  "timestamp": TIMESTAMP,
                  "type": "button",
                  "button": {
                    "text": "No",
                    "payload": "No-Button-Payload"
                  }
                }]
          },
          "field": "messages"
        }]
    }]
}

Received Answer From List Message

See Interactive Messages.

The following webhook notification is received when a user clicks on an item from a list message you sent:

Example Payload
{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
      "changes": [
        {
          "value": {
              "messaging_product": "whatsapp",
              "metadata": {
                   "display_phone_number": "PHONE_NUMBER",
                   "phone_number_id": "PHONE_NUMBER_ID",
              },
              "contacts": [
                {
                  "profile": {
                    "name": "NAME"
                  },
                  "wa_id": "PHONE_NUMBER_ID"
                }
              ],
              "messages": [
                {
                  "from": PHONE_NUMBER_ID,
                  "id": "wamid.ID",
                  "timestamp": TIMESTAMP,
                  "interactive": {
                    "list_reply": {
                      "id": "list_reply_id",
                      "title": "list_reply_title",
                      "description": "list_reply_description"
                    },
                    "type": "list_reply"
                  },
                  "type": "interactive"
                }
              ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

Received Answer to Reply Button

See Interactive Messages.

The following webhook notification is received when a user clicks on a reply button you sent:

Example Payload
{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
      "changes": [
        {
          "value": {
              "messaging_product": "whatsapp",
              "metadata": {
                   "display_phone_number": "PHONE_NUMBER",
                   "phone_number_id": PHONE_NUMBER_ID,
              },
              "contacts": [
                {
                  "profile": {
                    "name": "NAME"
                  },
                  "wa_id": "PHONE_NUMBER_ID"
                }
              ],
              "messages": [
                {
                  "from": PHONE_NUMBER_ID,
                  "id": "wamid.ID",
                  "timestamp": TIMESTAMP,
                  "interactive": {
                    "button_reply": {
                      "id": "unique-button-identifier-here",
                      "title": "button-text",
                    },
                    "type": "button_reply"
                  },
                  "type": "interactive"
                }
              ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

Received Message Triggered by Click to WhatsApp Ads

You get the following webhook when a conversation is started after a user clicks an ad with a Click to WhatsApp’s call-to-action:

Example Payload
{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "ID",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "PHONE_NUMBER",
              "phone_number_id": "PHONE_NUMBER_ID"
            },
            "contacts": [
              {
                "profile": {
                  "name": "NAME"
                },
                "wa_id": "ID"
              }
            ],
            "messages": [
              {
                "referral": {
                  "source_url": "AD_OR_POST_FB_URL",
                  "source_id": "ADID",
                  "source_type": "ad or post",
                  "headline": "AD_TITLE",
                  "body": "AD_DESCRIPTION",
                  "media_type": "image or video",
                  "image_url": "RAW_IMAGE_URL",
                  "video_url": "RAW_VIDEO_URL",
                  "thumbnail_url": "RAW_THUMBNAIL_URL",
                  "ctwa_clid": "CTWA_CLID"
                },
                "from": "SENDER_PHONE_NUMBERID",
                "id": "wamid.ID",
                "timestamp": "TIMESTAMP",
                "type": "text",
                "text": {
                  "body": "BODY"
                }
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

Flow completed

When the 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.

Example Payload
{
  "messages": [{
    "context": {
      "from": "16315558151",
      "id": "gBGGEiRVVgBPAgm7FUgc73noXjo"
    },
    "from": "<USER_ACCOUNT_NUMBER>",
    "id": "<MESSAGE_ID>",
    "type": "interactive",
    "interactive": {
      "type": "nfm_reply",
      "nfm_reply": {
        "name": "flow",
        "response_json": {
            "flow_token": "<FLOW_TOKEN>", 
            "optional_param1": "<value1>",
            "optional_param2": "<value2>"
        }
      }
    },
    "timestamp": "<MESSAGE_SEND_TIMESTAMP>"
  }]
}

Request_message

See Conversational Components.

Example Payload
{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "<BUSINESS_DISPLAY_PHONE_NUMBER>",
              "phone_number_id": "<BUSINESS_PHONE_NUMBER_ID>"
            },
            "contacts": [
              {
                "profile": {
                  "name": "<WHATSAPP_USER_NAME>"
                },
                "wa_id": "<WHATSAPP_USER_ID>"
              }
            ],
            "messages": [
              {
                "from": "<WHATSAPP_USER_PHONE_NUMBER>",
                "id": "<WHATSAPP_MESSAGE_ID>",
                "timestamp": "<TIMESTAMP>",
                "type": "request_welcome"  // Indicates first time message from WhatsApp user
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

Product Inquiry Messages

A Product Inquiry Message is received when a customer asks for more information about a product. These can happen when:

  • a customer replies to Single or Multi-Product Messages, or

  • a customer accesses a business's catalog via another entry point, navigates to a Product Details page, and clicks Message Business about this Product.

A webhooks notification for a Product Inquiry Message looks like this:

Example Payload
{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "ID",
      "changes": [
        {
          "value": {
              "messaging_product": "whatsapp",
              "metadata": {
                   "display_phone_number": "PHONE_NUMBER",
                   "phone_number_id": "PHONE_NUMBER_ID",
              },
              "contacts": [
                {
                  "profile": {
                    "name": "NAME"
                  },
                  "wa_id": "PHONE_NUMBER_ID"
                }
              ],
              "messages": [
                {
                  "from": "PHONE_NUMBER",
                  "id": "wamid.ID",
                  "text": {
                    "body": "MESSAGE_TEXT"
                  },
                  "context": {
                    "from": "PHONE_NUMBER",
                    "id": "wamid.ID",
                    "referred_product": {
                      "catalog_id": "CATALOG_ID",
                      "product_retailer_id": "PRODUCT_ID"
                    }
                  },
                  "timestamp": "TIMESTAMP",
                  "type": "text"
                }
              ]
          },