WhatsApp Business Cloud API

Webhooks Setup

WhatsApp Business Blog

Subscribe to Webhooks to get notifications about messages your business receives and customer profile updates.

Create an Endpoint

Before you can start receiving notifications you will need to create an endpoint on your server to receive notifications.

Your endpoint must be able to process two types of HTTPS requests: Verification Requests and Event Notifications. Since both requests use HTTPs, your server must have a valid TLS or SSL certificate correctly configured and installed. Self-signed certificates are not supported.

Learn more about Verifying Requests and Event Notifications

Webhooks set up will not affect the phone number on your WhatsApp Business App. Only after you migrate your number over to the WhatsApp Business Platform can you no longer use that number on your WhatsApp Business App.

Subcribe to Webhooks

To subscribe to Webhooks, you will need to get a Meta App ID and permissions. To do this go to the Meta App Dashboard. There you will:

  1. Create a Business Type App in the Meta App Dashboard
  2. Add the Webhooks Product to your Meta app in the App Dashboard

    At any time, each Meta App can have only one endpoint configured. If you need to send your webhook updates to multiple endpoints, you need multiple Meta Apps.

If you are a Business Solution Provider (BSP), you may need to:

  1. Add the whatsapp_business_messaging permission in your App Dashboard
  2. Successfully complete Meta App Review – This step will take time but you can continue to test during the entire review process.

Understanding Webhooks

Whenever a trigger event occurs, the WhatsApp Business Platform sees the event and sends a notification to a Webhook URL you have previously specified. You can get two types of notifications:

  • Received messages: This alert lets you know when you have received a message. These can also be called "inbound notifications" throughout the documentation.
  • Message status and pricing notifications: This alert lets you know when the status of a message has changed —for example, the message has been read or delivered. These can also be called "outbound notifications" throughout the documentation.

All Webhooks have the following generic format:

{
  "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"
              },
              # specific Webhooks payload            
          },
          "field": "messages"
        }]
    }]
}

See Components for information on each field.

If you receive a message that is not supported for Cloud API, you will get an unknown message webhook.

Sample App Endpoints

Create a sample app endpoint to test your webhooks.

Next Steps

Learn more about the information you can receive in a Webhooks notification.