Webhook Variables

Variables used in webhook to extract the incoming messages

Below are the variables used in webhook request, you need to extract the value from the below variables;

Variable	Details	Type
number	Mobile number with country code of the sender. For Whatsapp Group (web automation) the number will be Group Name @Sender Name / Number For phone automation if the sender mobile number is already saved in the phone contacts then instead of number the contact name may append as number.	String
messenger_id	Unique User id allocated by facebook to identify user, this id need to be passed when you use Push API to send message	Numeric
name	Name of the User Only supports in WhatsApp Official, WhatsApp Web Automation & Messenger	String
message-in	Text message received in the application – only first 2500 characters will be pushed to the server for WhatsApp Phone Automation Data is URL Encoded You need to decode it	String
message_in_raw	Text Messages in Raw Format, no URL Encoding Variable Added on 19, Feb, 2021	String
application	.On which messaging app the message has received 1 = Whatsapp Personal (Phone Automation) 2 = Whatsapp Business (Phone Automation) 3 = SMS (Phone Automation) 4 = Call (Phone Automation) 5 = Facebook Messenger 8 = WhatsApp Official 10 = WhatsApp Web Automation If you have connected multiple channels or using WhatsApp Cloud api then please get the channel id from your project under Settings -> Channels	Numeric
direction	0 = Inbound 1 = Outbound 1=outbound will be triggered only for WhatsApp Web Automation when enabled from the Settings	Numeric
group-id	If the message is received in a group the group id will be present Group Feature is Depreciated in WhatsApp Official Business, supports only in WhatsApp Web Automation Channel	String
group-mentions	All mentioning in the group will be in an array	Array
context-msg-id	If the user replied to your another message then you will get the message id of the parent message to identify the context of the conversation. Read More	Numeric
type	What kind of message is received 1 = text 2 = image 3 = video 4 = audio 5 = location (not supported in phone automation) 6 = document 7 = contact (not supported in phone automation) 9 = WhatsApp Official Interactive Buttons	Numeric
media-url	URL to download the media shared by the user We dont support fetching incoming media for phone automation.	URL
unique-id	Unique id assigned by the picky assist application for each inbound messages. (Its just for your reference )	Numeric
project-id	Project ID in which the message is received, useful if a single URL handles webhook for multiple projects (Its just for your reference)	Numeric
location	Location values need to pass as array name = name of the location address = Address of the Location url = URL of the Address (only for incoming locations) lat = Latitude long = Longitude Not Supported in Phone Automation	Array
contact	Contact as Array, in case multiple contact shared then same will be passed as multiple array's first_name = First Name last_name = Last Name phone = Phone Number city = City country = Country country_code = Country Short Code state = State street = Street address_type = Address Type zip = Postal Code email = Email Address company = Company Name contact_image = Base 64 code of the contact image Not Supported in Phone Automation , Messenger	Array
your-variable	Custom variable you configured to the webhook will be passed	String
payload	Custom Payload / value which passed while sending the message for WhatsApp Interactive Buttons (Quick Replies)	String
interactive	Array in which Interactive List or Reply button payload will be posted	Array
type	1 = List Messages 2 = Quick Reply Button	Numeric
id	Unique reference value you passed for choice or button when message is sent	String
description	Description of the Choice in a List Message Menu	String
referral	This is applicable only for WhatsApp Official Accounts and following details will be passed in this array when a user sends you a message on WhatsApp by clicking any of your Facebook/Instagram Ad's	Array
headline	Headline Used in the Ad that generated the messages	String
body	Body from the Ad that generated the message	String
source_type	The type of the ad’s source. Currently, supported values are ad and post.	String
source_id	Facebook ID for an ad or a post.	String
source_url	The url that leads to the ad.	String
image	The image that the user saw and clicked.	String
video	The video that the user saw and clicked.	String

Response Variables

If you would like to given an instant reply to the incoming messages then you need to give reply in JSON format, refer the below details;

Variable	Details	Type
message-out	Pass message you need to give as reply.	Text
delay	If you would like to give response by setting a delay then please pass the delay value in “delay” variable , delay need to be set in seconds and maximum allowed delay is 3600 seconds i.e delay=10 means message will send after 10 seconds	Numeric
media-url	If you would like to reply with a media file then provide the complete URL of the media. Please note the media URL should be publicly available. If you pass media URL for phone automation then response message may be delayed since its make use of Auto Click. Method so we highly recommend to use media only when its required for phone automation.	URL
reference_number	You can pass any value here like your internal message id etc and the same will be returned in the Event Webhook i.e Delivery Reports Please note we don't check for duplicate or unique values here, we just return the value you passed	String
application	Specify from which application the reply back need to be send 0 = Use Inbound Application 1 = Whatsapp Personal (Phone Automation) 2 = Whatsapp Business (Phone Automation) 3 = SMS (Phone Automation) 4 = Call (Phone Automation) 5 = Facebook Messenger 8 = WhatsApp Official 10 = WhatsApp Web Automation Shared Number 919737001155 = Shared Number India Coming Soon Services 6 = Telegraph 7 = Web	Numeric
type	What kind of message you need to give as response 1 = text 2 = image 3 = video 4 = audio 5 = location 6 = document 7 = contact Contact & Location not support in phone automation Contact & Location data need to pass as an array , rest all media need to pass through "media-url" as URL	Numeric
location	Location values need to pass as array name = name of the location address = Address of the Location url = URL of the Address lat = Latitude long = Longitude Not Supported in Phone Automation , FB Messenger	Array
contact	Contact value need to pass as Array, in case multiple contacts need to sent then same need to be passed as multiple array's first_name = First Name last_name = Last Name phone = Phone Number city = City country = Country state = State street = Street zip = Postal Code email = Email Address company = Company Name contact_image = Base 64 code of the contact image Not Supported in Phone Automation , Messenger	Array

The reply should be in JSON Format & message-in variable is URL encoded you need to decode it

For SMS if you pass "media-url" then it will append the URL at the end of message

If you pass application=0 in the response then we will use the same incoming application to send the reply.