Enqueued - V3 Event

Type of object that sent the event	{
  "entry": [
    {
      "changes": [
        {
          "field": "messages",
          "value": {
            "messaging_product": "whatsapp",
            "statuses": [
              {
                "gs_id": "2baff204-c39a-4121-90b5-f53f26d522b3",
                "id": "wamid.HBgMOTE5MTYzODA1ODczFQIAERgSNkZCMThGMEEwQzJDOUFGQjFBAA==",
                "recipient_id": "9191****873",
                "status": "enqueued",
                "timestamp": 1710941393420
              }Type of object that sent the event	
            ]
          }
        }
      ]
    }
  ],
  "gs_app_id": "82ed52f4-30c0-4f12-81b4-e7ad07bd41de",
  "object": "whatsapp_business_account"
}

Payload Description

Key	Description	Example
object	Type of object that sent the event	whatsapp_business_account
gs_app_id	Gupshup application ID	82ed52f4-30c0-4f12-81b4-e7ad07bd41de
messaging_product	Messaging product	whatsapp
statuses[].id	WhatsApp message ID (wamid)	wamid.HBgMOTE5...
statuses[].recipient_id	Destination phone number	9191****873
statuses[].status	Message status	enqueued
statuses[].timestamp	Time when status was updated (s or ms)	1710941393420

Sent - V3 Event

{
  "entry": [
    {
      "changes": [
        {
          "field": "messages",
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "9****8",
              "phone_number_id": "158072934066266"
            },
            "statuses": [
              {
                "conversation": {
                  "expiration_timestamp": "1710936120",
                  "id": "3dabdf65abaf1cbbf85217d232cce91f"
                },
                "gs_id": "7daeb742-f2dc-4c09-90e0-d879d20f7b98",
                "id": "wamid.HBgMOTE5MTYzODA1ODczFQIAERgSMDQ4Rj...",
                "recipient_id": "91****73",
                "status": "sent",
                "timestamp": "1710930461"
              }
            ]
          }
        }
      ],
      "id": "112535025189792"
    }
  ],
  "gs_app_id": "82ed52f4-30c0-4f12-81b4-e7ad07bd41de",
  "object": "whatsapp_business_account"
}

Payload Description

Key	Description	Example
object	Type of object that sent the event	whatsapp_business_account
gs_app_id	Gupshup application ID	82ed52f4-30c0-4f12-81b4-e7ad07bd41de
metadata.display_phone_number	Display phone number	9******8
metadata.phone_number_id	Phone number ID	158072934066266
statuses[].conversation.id	Conversation ID	3dabdf65abaf1cbbf85217d232cce91f
statuses[].id	WhatsApp message ID (wamid)	wamid.HBgMOTE5...
statuses[].recipient_id	Destination phone number	91*****3
statuses[].status	Message status	sent
statuses[].timestamp	Timestamp (in seconds)	1710930461

Delivered - V3 Event

{
  "entry": [
    {
      "changes": [
        {
          "field": "messages",
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "9*****58",
              "phone_number_id": "158072934066266"
            },
            "statuses": [
              {
                "conversation": {
                  "id": "3dabdf65abaf1cbbf85217d232cce91f"
                },
                "gs_id": "7daeb742-f2dc-4c09-90e0-d879d20f7b98",
                "id": "wamid.HBgMOTE5MTYzODA1ODczFQIAERgSMDQ4Rj...",
                "recipient_id": "91****873",
                "status": "delivered",
                "timestamp": "1710930462"
              }
            ]
          }
        }
      ],
      "id": "112535025189792"
    }
  ],
  "gs_app_id": "82ed52f4-30c0-4f12-81b4-e7ad07bd41de",
  "object": "whatsapp_business_account"
}

Payload Description

Key	Description	Example
object	Type of object that sent the event	whatsapp_business_account
gs_app_id	Gupshup application ID	82ed52f4-30c0-4f12-81b4-e7ad...
metadata.display_phone_number	Display phone number	91****58
metadata.phone_number_id	Phone number ID	158072934066266
statuses[].conversation.id	Unique conversation ID	3dabdf65abaf1cbbf85217d232cce91f
statuses[].id	WhatsApp message ID (wamid)	wamid.HBgMOTE5MTYz...
statuses[].recipient_id	Destination phone number	91*****3
statuses[].status	Message status	delivered
statuses[].timestamp	Timestamp (in seconds) for delivery	1710930462

Read-V3 Event

{
  "entry": [
    {
      "changes": [
        {
          "field": "messages",
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "9*******8",
              "phone_number_id": "158072934066266"
            },
            "statuses": [
              {
                "gs_id": "7b8f0910-db98-4cce-be5f-e6e1e847b4bd",
                "id": "wamid.HBgMOTE5MTYzODA1ODczFQIAERgSMUUzNz...",
                "recipient_id": "91*******73",
                "status": "read",
                "timestamp": "1720779817"
              }
            ]
          }
        }
      ],
      "id": "112535025189792"
    }
  ],
  "gs_app_id": "82ed52f4-30c0-4f12-81b4-e7ad07bd41de",
  "object": "whatsapp_business_account"
}

Payload Description

Key	Description	Example
object	Type of object that sent the event	whatsapp_business_account
gs_app_id	Gupshup application ID	82ed52f4-30c0-4f12-81b4-e7ad...
metadata.display_phone_number	Display phone number	91*****8
metadata.phone_number_id	Phone number ID	158072934066266
statuses[].id	WhatsApp message ID (wamid)	wamid.HBgMOTE5MTYz...
statuses[].recipient_id	Destination phone number	91****73
statuses[].status	Message status	read
statuses[].timestamp	Timestamp for the "read" status	1720779817

Failed-V3 Event

{
  "entry": [
    {
      "changes": [
        {
          "field": "messages",
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "91*******8",
              "phone_number_id": "158072934066266"
            },
            "statuses": [
              {
                "errors": [
                  {
                    "code": 131047,
                    "href": "https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes/",
                    "title": "Message failed to send..."
                  }
                ],
                "gs_id": "91f58e90-f5ba-4cfc-9ca7-e4ab965b9449",
                "id": "wamid.HBgMOTE3OTgwODkwOTc4FQIAERgSNERF...",
                "recipient_id": "91*******78",
                "status": "failed",
                "timestamp": "1710941507"
              }
            ]
          }
        }
      ],
      "id": "112535025189792"
    }
  ],
  "gs_app_id": "82ed52f4-30c0-4f12-81b4-e7ad07bd41de",
  "object": "whatsapp_business_account"
}

Payload Description

Key	Description	Example
object	Type of object that sent the event	whatsapp_business_account
gs_app_id	Gupshup application ID	82ed52f4-30c0-4f12-81b4-e7ad...
metadata.display_phone_number	Display phone number	91*******8
metadata.phone_number_id	Phone number ID	158072934066266
statuses[].errors[].code	Error code	131047
statuses[].errors[].title	Error title	"Message failed to send..."
statuses[].id	WhatsApp message ID (wamid)	wamid.HBgMOTE3OTgwODkwOTc4FQIAERgSNERF...
statuses[].recipient_id	Destination phone number	91*******8
statuses[].status	Message status	failed
statuses[].timestamp	Timestamp of message failure	1710941507