# Location messages webhook reference | Developer Documentation

<div id="bkmrk-location-messages-we">## Location messages webhook reference

<div><span>Updated: Oct 22, 2025</span></div><div>This reference describes trigger events and payload contents for the WhatsApp Business Account **messages** webhook for messages containing location information.</div><div id="bkmrk-triggers"><div id="bkmrk-triggers-1"><div>### Triggers

</div></div></div>
<span>A WhatsApp user sends a location message to a business.</span><span>A WhatsApp user sends a location to a business via a Click to WhatsApp ad.</span><div id="bkmrk-parameters"><div id="bkmrk-parameters-1"><div>### Parameters

</div></div></div><div><table style="width:100%;table-layout:fixed;"><thead><tr><th style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;width:28%;overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><span>Placeholder </span></th><th style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;width:47%;overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><span>Description </span></th><th style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;width:25%;overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><span>Example value </span></th></tr></thead><tbody><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<AD_CLICK_ID>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Click to WhatsApp ad click ID.</div><div>The `ctwa_clid` property is omitted entirely for messages originating from an ad in WhatsApp Status ([WhatsApp Status ad placements<span>?</span>](https://www.facebook.com/business/help/1074444721456755)).</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`Aff-n8ZTODiE79d22KtA...aIAeUzHL50`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<AD_GREETING_TEXT>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Click to WhatsApp ad greeting text.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`Hi there! Let us know how we can help!`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<AD_HEADLINE>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Click to WhatsApp ad headline.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`Chat with us`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<AD_ID>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Click to WhatsApp ad ID.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`120226305854810726`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<AD_IMAGE_URL>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Click to WhatsApp ad image URL. Only included if the ad is an image ad.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`https://scontent.xx.fbcdn.net/v/t45.1...`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<AD_MEDIA_TYPE>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Click to WhatsApp ad media type. Values can be:</div><div>`image` - Indicates an image ad.</div><div>`video` - Indicates a video ad.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`image`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<AD_PRIMARY_TEXT>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Click to WhatsApp ad primary text.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`Summer succulents are here!`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<AD_URL>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Click to WhatsApp ad URL.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`https://fb.me/3cr4Wqqkv`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<AD_VIDEO_THUMBNAIL>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Click to WhatsApp ad video thumbnail URL. Only included if ad is a video ad.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`https://scontent.xx.fbcdn.net/v/t45.3...`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<AD_VIDEO_URL>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Click to WhatsApp ad video URL. Only included if ad is a video ad.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`https://scontent.xx.fbcdn.net/v/t45.2...`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<BUSINESS_DISPLAY_PHONE_NUMBER>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Business display phone number.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`15550783881`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<BUSINESS_PHONE_NUMBER_ID>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Business phone number ID.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`106540352242922`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<IDENTITY_KEY_HASH>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Identity key hash. Only included if you have enabled the [identity change check](/books/meta-whatsapp/page/business-phone-numbers-developer-documentation) feature.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`DF2lS5v2W6x=`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<LOCATION_ADDRESS>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Location address.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`101 Forest Ave, Palo Alto, CA 94301`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<LOCATION_LATITUDE>`</div><div>*Float*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Location latitude in decimal degrees.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`37.44221496582`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<LOCATION_LONGITUDE>`</div><div>*Float*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Location longitude in decimal degrees.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`-122.16165924072`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<LOCATION_NAME>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Location name.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`Philz Coffee`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<LOCATION_URL>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Location URL. Usually only included for business locations.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`https://philzcoffee.com/`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<WEBHOOK_TRIGGER_TIMESTAMP>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>Unix timestamp indicating when the webhook was triggered.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`1739321024`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<WHATSAPP_BUSINESS_ACCOUNT_ID>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>WhatsApp Business Account ID.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`102290129340398`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<WHATSAPP_MESSAGE_ID>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>WhatsApp message ID.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`wamid.HBgLMTY1MDM4Nzk0MzkVAgASGBQzQUFERjg0NDEzNDdFODU3MUMxMAA=`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<WHATSAPP_USER_ID>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>WhatsApp user ID. Note that a WhatsApp user's ID and phone number may not always match.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`16505551234`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<WHATSAPP_USER_PHONE_NUMBER>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>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.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`+16505551234`</div></div></td></tr><tr><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`<WHATSAPP_USER_PROFILE_NAME>`</div><div>*String*</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>WhatsApp user's name as it appears in their profile in the WhatsApp client.</div></div></td><td style="overflow-wrap:anywhere;word-break:break-word;vertical-align:top;"><div><div>`Sheena Nelson`</div></div></td></tr></tbody></table>

</div></div>