> ## Documentation Index
> Fetch the complete documentation index at: https://docs.heyy.io/llms.txt
> Use this file to discover all available pages before exploring further.
# message.updated
> Occurs when an existing message changes, such as a delivery status update.
export const MessageWebhookPayloadFields = () => <>
Unique identifier for this webhook payload delivery.
The tenant that triggered this webhook event.
The event type for this webhook payload.
The message object associated with the event.
Message id.
ISO datetime when the message was created.
ISO datetime when the message was last updated.
Chat id this message belongs to.
Channel id this message belongs to.
Message type.
Who sent the message.
Provenance for the message (where it originated).
The source type.
Present when `type` is `"campaign"`.
Present when `type` is `"automation"`.
Present when `type` is `"inbox"`.
Present when `type` is `"api"`.
Present when `type` is `"ai_agent"`.
Message delivery status.
Scheduled send time (ISO datetime) if scheduled; otherwise `null`.
Message content.
Text body of the message (if present).
Attachments for the message (if present).
Attachment id.
Attachment type discriminator.
Present for media attachments (`image`, `video`, `document`, `audio`) when available.
File id.
File created timestamp.
File type.
File name.
MIME type.
Download URL.
File size in bytes.
Present for `audio` attachments; indicates a voice note.
Present for `location` attachments.
Present for `location` attachments.
Present for `location` attachments.
Present for `location` attachments.
Present for `contact` attachments.
Present for `contact` attachments.
Present for `contact` attachments.
Present for `contact` attachments.
Present for `contact` attachments.
Present for `contact` attachments.
Present for `button` attachments.
Present for `button` and `list_section` attachments.
Present for `button` attachments when available.
Present for `button` attachments.
Present for `button` attachments with `data.type = "phone_number"`.
Present for `button` attachments with a URL.
Present for `button` attachments with `data.type = "dynamic_url"`.
Present for `button` attachments and for `quick_reply` attachments.
Present for `list_section` attachments.
Present for `list_section` attachments.
Present for `list_section` attachments.
Present for `list_section` attachments.
Present for `list_section` attachments.
Present for `ai_tool_call` attachments.
Present for `ai_tool_call` attachments.
Present for `ai_tool_call` attachments.
Present for `ai_tool_call` attachments.
Present for `ai_tool_call` attachments.
Present for `referral` attachments.
Present for `referral` attachments.
Present for `referral` attachments.
Present for `referral` attachments.
Present for `referral` attachments.
Present for `referral` attachments.
Present for `referral` attachments.
Present for `referral` attachments.
Present for `referral` attachments.
Present for `referral` attachments.
Present for `referral` attachments.
Present for `content_reference` attachments.
Present for `content_reference` attachments.
Present for `content_reference` attachments.
Optional header text (if present).
Optional footer text (if present).
Optional payload (e.g. interactive response payload) if present.
Whether the message was forwarded.
Present when the message is a reply to another message.
Replied-to message id.
Vendor message id (if available).
Sender of the replied-to message.
Preview type.
Timestamp of the replied-to message.
Preview text (if applicable).
Message reactions.
Reaction sender.
Present for inbox/user reactions.
Reaction text/emoji.
Reaction timestamp.
Errors associated with this message (if any).
Machine-readable error key.
Human-readable error message.
Vendor-specific error details (if provided).
Vendor error code.
Vendor error title.
Vendor error type.
Vendor error message.
Vendor error data payload.
Vendor messaging product (if present).
Vendor error details (if present).
Vendor trace id (if present).
Status transition history entries.
History event type.
New status after the update.
Status update timestamp.
Vendor message id (if available).
Message timestamp (ISO datetime).
Vendor-specific details (if available).
WhatsApp vendor details (if available).
WhatsApp context details (if available).
Whether WhatsApp marks this as frequently forwarded.
Referred product details (if present).
Catalog id.
Product retailer id.
WhatsApp order details (if present).
Catalog id (if present).
Ordered product items (if present).
Product retailer id.
Quantity.
Item price.
Currency.
Instagram vendor details (if available).
Instagram comment id (if present).
Integration metadata (if present).
Campaign contact id (if present).
Campaign execution id (if present).
Whether this message is marked sensitive.
AI generation id (if the message was generated by AI); otherwise `null`.
The chat this message belongs to.
Chat id.
The contact handle (identity) used for this chat.
Handle id.
Handle type.
Handle value (for example, a phone number in E.164 format, an email address, an Instagram id etc.).
The contact associated with the message.
Contact id.
Contact first name (if present).
Contact last name (if present).
Contact phone number (if present).
Contact email (if present).
The channel this message was sent/received on.
Channel id.
Channel type.
Channel display name.
;
Event triggered when an **existing message changes** — most commonly delivery status transitions like `sent` → `delivered` → `read`.
## Payload fields
```json theme={null}
{
"id": "c9d0e1f2-a3b4-4c5d-6e7f-8a9b0c1d2e3f",
"tenantId": "a98d0e1f2-a1b4-4c4d-6e7f-8a9b0c1d2e3f",
"event": "message.updated",
"data": {
"id": "d0e1f2a3-b4c5-4d6e-7f8a-9b0c1d2e3f4a",
"type": "message",
"sender": "outbound",
"sources": [
{
"type": "inbox",
"userId": "a3b4c5d6-e7f8-4a9b-0c1d-2e3f4a5b6c7d"
}
],
"status": "delivered",
"scheduledAt": null,
"content": {
"body": "Hello world"
},
"forwarded": false,
"reactions": [],
"errors": [],
"history": [
{
"event": "status_update",
"newStatus": "pending",
"timestamp": "2026-03-13T23:26:57.275Z"
},
{
"event": "status_update",
"newStatus": "sent",
"timestamp": "2026-03-13T23:26:58.000Z"
},
{
"event": "status_update",
"newStatus": "delivered",
"timestamp": "2026-03-13T23:26:58.000Z"
}
],
"vendorId": "a1f2e3d4-c5b6-4a97-8e8f-0d1c2b3a4e5f",
"timestamp": "2026-03-13T23:26:57.275Z",
"vendorDetails": null,
"isSensitive": false,
"aiGenerationId": null,
"metadata": {},
"chat": {
"id": "5f3700cd-a5cf-4b2b-be5a-23b013025c11"
},
"handle": {
"id": "1a9559d7-3c53-4cd5-a076-962193b206e9",
"type": "phone_number",
"value": "+12135550123"
},
"contact": {
"id": "259c9fec-c831-41ad-8a43-3fdad389d015",
"firstName": "John",
"lastName": "Doe",
"phoneNumber": "+12135550123",
"email": "john@example.com"
},
"channel": {
"id": "h9dd4c3e-b049-4903-b047-e2717f1e88e3",
"type": "whatsapp",
"name": "Examply"
}
}
}
```