Messages
Events that fire when a message is created, updated, opened, or bounced.
Events that fire when a message is created, updated, opened, or bounced.
Events
| Event | When it fires |
|---|---|
message.created | A new SMS, MMS, email, WhatsApp, note, or other message is created. |
message.updated | A message changes — typically delivery status, body, or metadata updates. |
message.opened | An outbound email is opened (Mailgun open tracking). |
message.bounced | An outbound email permanently or temporarily fails (Mailgun bounce). |
Examples
Each example is the full POST body Whippy sends, including the envelope fields data, api_version, event, created_at, and request_id.
message.created
message.createdA new SMS, MMS, email, WhatsApp, note, or other message is created.
{
"data": {
"id": "5e09c7cc-27e8-4d91-89ee-4ea5bafaaa15",
"delivery_status": "pending",
"error": null,
"error_code": null,
"error_message": null,
"direction": "OUTBOUND",
"type": "sms",
"mode": "manual",
"body": "Olá, Clark Kent, obrigado por enviar mensagens à Organização 1. Um membro de nossa equipe entrará em contato com você em breve neste número.",
"translated_body": null,
"attachments": [],
"language": null,
"translation_language": null,
"created_at": "2023-08-24T10:05:18.432652Z",
"updated_at": "2023-08-24T10:05:18.432652Z",
"conversation_id": "742993a5-c9c6-4d7d-bf09-31417a1c04a9",
"contact_id": "8241b8e5-98a2-44d7-975b-15f5c2bf3cf4",
"channel_id": "be1ecaf2-9ce7-448c-8755-e5009ccc4345",
"user_id": null,
"campaign_id": null,
"campaign_contact_id": null,
"step_id": null,
"step_contact_id": null,
"sequence_id": null,
"metadata": {},
"email_metadata": {},
"to": "+14244023931",
"from": "+12183925232"
},
"api_version": "v1",
"event": "message.created",
"created_at": "2025-08-19T06:40:57.416929Z",
"request_id": "1e775515-041c-51a7-8046-3a8f7d8b3f69"
}message.updated
message.updatedA message changes — typically delivery status, body, or metadata updates.
{
"data": {
"id": "5e09c7cc-27e8-4d91-89ee-4ea5bafaaa15",
"delivery_status": "failed",
"error": null,
"error_code": null,
"error_message": null,
"direction": "OUTBOUND",
"type": "sms",
"mode": "manual",
"body": "Olá, Clark Kent, obrigado por enviar mensagens à Organização 1. Um membro de nossa equipe entrará em contato com você em breve neste número.",
"translated_body": null,
"attachments": [],
"language": null,
"translation_language": null,
"created_at": "2023-08-24T10:52:28.430748Z",
"updated_at": "2023-08-24T10:52:28.498798Z",
"conversation_id": "742993a5-c9c6-4d7d-bf09-31417a1c04a9",
"contact_id": "8241b8e5-98a2-44d7-975b-15f5c2bf3cf4",
"channel_id": "be1ecaf2-9ce7-448c-8755-e5009ccc4345",
"user_id": null,
"campaign_id": null,
"campaign_contact_id": null,
"step_id": null,
"step_contact_id": null,
"sequence_id": null,
"metadata": {},
"email_metadata": {},
"to": "+14244023931",
"from": "+12183925232"
},
"api_version": "v1",
"event": "message.updated",
"created_at": "2025-08-19T06:40:57.416929Z",
"request_id": "0caa1233-97ad-532f-8aa4-b1251d62eab1"
}message.opened
message.openedAn outbound email is opened (Mailgun open tracking).
{
"data": {
"id": "c57adf9e-3db5-41f3-a184-bfe3a2efb871",
"delivery_status": "opened",
"error": null,
"error_code": null,
"error_message": null,
"direction": "OUTBOUND",
"type": "email",
"mode": "manual",
"body": "Sending Outbound Message",
"translated_body": null,
"attachments": [],
"language": null,
"translation_language": null,
"created_at": "2026-06-10T07:33:10.875685Z",
"updated_at": "2026-06-10T10:34:44.147440Z",
"conversation_id": "dc3a6ea4-0462-43c0-8692-6265c3fe4230",
"contact_id": "9f975671-b296-4dcf-9e94-f9beb9d40c41",
"channel_id": "4dfa903b-d702-4a40-a019-7d21991dfbb6",
"user_id": 1,
"campaign_id": null,
"campaign_contact_id": null,
"step_id": null,
"step_contact_id": null,
"sequence_id": null,
"metadata": {},
"email_metadata": {
"cc": [],
"to": [],
"bcc": [],
"subject": "Re: Test Campaign",
"reply_to": null,
"sender_name": null,
"sender_email": null
},
"to": "[email protected]",
"from": "[email protected]"
},
"api_version": "v1",
"event": "message.opened",
"created_at": "2025-08-19T06:40:57.416929Z",
"request_id": "8b83774d-abdb-5fdf-a257-5bd48287b24b"
}message.bounced
message.bouncedAn outbound email permanently or temporarily fails (Mailgun bounce).
{
"data": {
"id": "cf6580fe-a479-49e5-8f9a-7e9f0e8996af",
"delivery_status": "failed",
"error": null,
"error_code": null,
"error_message": null,
"direction": "OUTBOUND",
"type": "email",
"mode": "manual",
"body": "Lets see the bounce",
"translated_body": null,
"attachments": [],
"language": null,
"translation_language": null,
"created_at": "2026-03-23T16:42:57.448266Z",
"updated_at": "2026-03-23T16:42:59.604275Z",
"conversation_id": "839941dd-27f2-45f3-91b6-4bda49a3a8bf",
"contact_id": "f5bfbfef-5277-4a65-b454-07df643d52ce",
"channel_id": "4dfa903b-d702-4a40-a019-7d21991dfbb6",
"user_id": 1,
"campaign_id": null,
"campaign_contact_id": null,
"step_id": null,
"step_contact_id": null,
"sequence_id": null,
"metadata": {},
"email_metadata": {
"cc": [],
"to": [],
"bcc": [],
"subject": "Re: Test Campaign",
"reply_to": null,
"sender_name": null,
"sender_email": null
},
"to": "[email protected]",
"from": "[email protected]"
},
"api_version": "v1",
"event": "message.bounced",
"created_at": "2025-08-19T06:40:57.416929Z",
"request_id": "9591d842-97a1-5ccc-b4b9-e620d69b3455"
}Updated 22 days ago
Did this page help you?
