Webhook event fields

Every field Whatsable posts from Settings, Webhooks, which shape includes it, and when the value is empty or missing.

Settings → Webhooks posts one JSON object per delivery. The two formats are Make, Zapier or n8n and Your own server. Neither payload has an event id. To add an endpoint, see outgoing webhooks. Examples and setup steps stay on message webhooks.

Outgoing webhooks are on Pro and Agency, and during the 14-day trial. Bulk Message does not include them.

Times are Unix seconds, not milliseconds. A missing message in the recent window is JSON null, not 0.

Fields

FieldJSON typeWhich deliveriesWhen it is empty or missing
last_messagesstringAllEmpty string when the window has no text
conversation_paragraphstringAllEmpty string when the window has no text
phone_numberstring, number, or nullAllA string on an incoming WhatsApp message. A number on an outgoing message and on a combined batch. null when the contact has no phone number
recipient_namestringAllEmpty string when the contact has no name
user_idstringAllAlways present
last_message_of_userstringIncoming, combined, and an outgoing delivery that has a contact messageOmitted entirely on an outgoing delivery whose window has no contact message. Not sent as an empty string in that case
last_message_of_botstringAllEmpty string when the window has no business message
message_typestringAllIncoming text that came from an ad is referral. An image or video from an ad keeps image or video. Outgoing and combined deliveries use the stored type and are not rewritten to referral
user_last_message_timenumber or nullAllnull when the window has no message from the contact
bot_last_message_timenumber or nullAllnull when the window has no message from the business
attachment_urlstringAllAlways sent, and empty for now. Whatsable does not put a public media link here
notestringAllEmpty string when the contact has no note
note_automationstringAllEmpty string when there is no automation note
labelsstring or arrayAllA comma-separated string on incoming and outgoing deliveries. An array of strings on a combined batch. Empty string, or an empty array, when the contact has no labels
incoming_messagebooleanYour own server, and outgoingtrue on Your own server. false on an outgoing delivery. Absent on an incoming Make, Zapier or n8n delivery, and absent on a combined batch
is_scheduledbooleanIncoming and combinedfalse on an incoming delivery. true on a combined batch. Absent on an outgoing delivery
send_bystringOutgoing onlyWhatsApp App for a reply typed in the WhatsApp Business app, AI for the AI agent and for a proactive follow-up, Notifyer for a reply from your team
was_message_by_humanbooleanOutgoing onlyfalse when the AI agent or a proactive follow-up sent it
scheduled_messagesstringCombined batch onlyThe batch as one string: Message 1: "...", then a space, U+2014, a space, then Message 2: "...". An empty batch is the string not text
referralobjectIncoming and combined, only with an adAbsent when the message is not from a Click-to-WhatsApp ad. See Click-to-WhatsApp fields
button_replyobjectIncoming and combined, only on a tapAbsent unless the contact tapped a button or a list row. Keys: id, title, message_id, whatsapp_message_id. Each id is null when it is unknown. See button replies
channelstringAllwhatsapp for a WhatsApp message
usernamestring or nullOnly when channel is not whatsappAbsent on WhatsApp
business_phone_number_idstringOnly an endpoint set to all numbersAbsent when the endpoint is bound to one number. Appended after channel
business_phone_numberstring or nullOnly an endpoint set to all numbersnull when that number has no display phone

send_by uses Notifyer because existing automations branch on that word. It is the previous product name.

The four shapes

  • Make, Zapier or n8n, incoming. One request per message. No incoming_message key. phone_number is a string. labels is a string. is_scheduled is false.
  • Your own server. Incoming messages only, one request per message. The same fields, plus "incoming_message": true.
  • Outgoing. phone_number is a number. Adds incoming_message, send_by and was_message_by_human. No is_scheduled. No referral and no button_reply.
  • Combined batch. Make, Zapier or n8n only, when Combine messages is on. is_scheduled is true, scheduled_messages is the batch, phone_number is a number, and labels is an array. No incoming_message, send_by, or was_message_by_human.
Outgoing webhooks

Add an endpoint, check the signature, and see how retries work.

Message webhooks

Setup steps and payload examples for the same events.

On this page