This reference describes trigger events and payload contents for the WhatsApp Business Account messages webhook for messages containing location information.

Triggers

A WhatsApp user sends a location message to a business.

A WhatsApp user sends a location to a business via a Click to WhatsApp ad.

Syntax

{
  "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_PROFILE_NAME>"
                },
                "wa_id": "<WHATSAPP_USER_ID>",
                "identity_key_hash": "<IDENTITY_KEY_HASH>" <!-- only included if identity change check enabled -->
              }
            ],
            "messages": [
              {
                "from": "<WHATSAPP_USER_PHONE_NUMBER>",
                "id": "<WHATSAPP_MESSAGE_ID>",
                "timestamp": "<WEBHOOK_TRIGGER_TIMESTAMP>",
                "location": {
                  "address": "<LOCATION_ADDRESS>",
                  "latitude": <LOCATION_LATITUDE>,
                  "longitude": <LOCATION_LONGITUDE>,
                  "name": "<LOCATION_NAME>",
                  "url": "<LOCATION_URL>"
                },
                "type": "location",

                <!-- only included if message sent via a Click to WhatsApp ad -->
                "referral": {
                  "source_url": "<AD_URL>",
                  "source_id": "<AD_ID>",
                  "source_type": "ad",
                  "body": "<AD_PRIMARY_TEXT>",
                  "headline": "<AD_HEADLINE>",
                  "media_type": "<AD_MEDIA_TYPE>",
                  "image_url": "<AD_IMAGE_URL>",
                  "video_url": "<AD_VIDEO_URL>",
                  "thumbnail_url": "<AD_VIDEO_THUMBNAIL>",
                  "ctwa_clid": "<AD_CLICK_ID>",
                  "welcome_message": {
                    "text": "<AD_GREETING_TEXT>"
                  }
                }
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

Parameters

Placeholder	Description	Example value
`<AD_CLICK_ID>` String	Click to WhatsApp ad click ID. The `ctwa_clid` property is omitted entirely for messages originating from an ad in WhatsApp Status (WhatsApp Status ad placements⁠).	`Aff-n8ZTODiE79d22KtAwQKj9e_mIEOOj27vDVwFjN80dp4_0NiNhEgpGo0AHemvuSoifXaytfTzcchptiErTKCqTrJ5nW1h7IHYeYymGb5K5J5iTROpBhWAGaIAeUzHL50`
`<AD_GREETING_TEXT>` String	Click to WhatsApp ad greeting text.	`Hi there! Let us know how we can help!`
`<AD_HEADLINE>` String	Click to WhatsApp ad headline.	`Chat with us`
`<AD_ID>` String	Click to WhatsApp ad ID.	`120226305854810726`
`<AD_IMAGE_URL>` String	Click to WhatsApp ad image URL. Only included if the ad is an image ad.	`https://scontent.xx.fbcdn.net/v/t45.1...`
`<AD_MEDIA_TYPE>` String	Click to WhatsApp ad media type. Values can be: `image` — Indicates an image ad. `video` — Indicates a video ad.	`image`
`<AD_PRIMARY_TEXT>` String	Click to WhatsApp ad primary text.	`Summer succulents are here!`
`<AD_URL>` String	Click to WhatsApp ad URL.	`https://fb.me/3cr4Wqqkv`
`<AD_VIDEO_THUMBNAIL>` String	Click to WhatsApp ad video thumbnail URL. Only included if ad is a video ad.	`https://scontent.xx.fbcdn.net/v/t45.3...`
`<AD_VIDEO_URL>` String	Click to WhatsApp ad video URL. Only included if ad is a video ad.	`https://scontent.xx.fbcdn.net/v/t45.2...`
`<BUSINESS_DISPLAY_PHONE_NUMBER>` String	Business display phone number.	`15550783881`
`<BUSINESS_PHONE_NUMBER_ID>` String	Business phone number ID.	`106540352242922`
`<IDENTITY_KEY_HASH>` String	Identity key hash. Only included if you have enabled the identity change check feature.	`DF2lS5v2W6x=`
`<LOCATION_ADDRESS>` String	Location address.	`101 Forest Ave, Palo Alto, CA 94301`
`<LOCATION_LATITUDE>` Float	Location latitude in decimal degrees.	`37.44221496582`
`<LOCATION_LONGITUDE>` Float	Location longitude in decimal degrees.	`-122.16165924072`
`<LOCATION_NAME>` String	Location name.	`Philz Coffee`
`<LOCATION_URL>` String	Location URL. Usually only included for business locations.	`https://philzcoffee.com/`
`<WEBHOOK_TRIGGER_TIMESTAMP>` String	Unix timestamp indicating when the webhook was triggered.	`1739321024`
`<WHATSAPP_BUSINESS_ACCOUNT_ID>` String	WhatsApp Business Account ID.	`102290129340398`
`<WHATSAPP_MESSAGE_ID>` String	WhatsApp message ID.	`wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUFERjg0NDEzNDdFODU3MUMxMAA=`
`<WHATSAPP_USER_ID>` String	WhatsApp user ID. Note that a WhatsApp user’s ID and phone number may not always match.	`16505551234`
`<WHATSAPP_USER_PHONE_NUMBER>` String	WhatsApp user phone number. This is the same value returned by the API as the `input` value when sending a message to a WhatsApp user. Note that a WhatsApp user’s phone number and ID may not always match.	`+16505551234`
`<WHATSAPP_USER_PROFILE_NAME>` String	WhatsApp user’s name as it appears in their profile in the WhatsApp client.	`Sheena Nelson`

Example

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "102290129340398",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "15550783881",
              "phone_number_id": "106540352242922"
            },
            "contacts": [
              {
                "profile": {
                  "name": "Sheena Nelson"
                },
                "wa_id": "16505551234"
              }
            ],
            "messages": [
              {
                "from": "16505551234",
                "id": "wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUFERjg0NDEzNDdFODU3MUMxMAA=",
                "timestamp": "1744344496",
                "location": {
                  "address": "101 Forest Ave, Palo Alto, CA 94301",
                  "latitude": 37.44221496582,
                  "longitude": -122.16165924072,
                  "name": "Philz Coffee",
                  "url": "https://philzcoffee.com/"
                },
                "type": "location"
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

Did you find this page helpful?