Home
Guides

Events

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

KeyDescriptionExample
objectType of object that sent the eventwhatsapp_business_account
gs_app_idGupshup application ID82ed52f4-30c0-4f12-81b4-e7ad07bd41de
messaging_productMessaging productwhatsapp
statuses[].idWhatsApp message ID (wamid)wamid.HBgMOTE5...
statuses[].recipient_idDestination phone number9191****873
statuses[].statusMessage statusenqueued
statuses[].timestampTime 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

KeyDescriptionExample
objectType of object that sent the eventwhatsapp_business_account
gs_app_idGupshup application ID82ed52f4-30c0-4f12-81b4-e7ad07bd41de
metadata.display_phone_numberDisplay phone number9******8
metadata.phone_number_idPhone number ID158072934066266
statuses[].conversation.idConversation ID3dabdf65abaf1cbbf85217d232cce91f
statuses[].idWhatsApp message ID (wamid)wamid.HBgMOTE5...
statuses[].recipient_idDestination phone number91*****3
statuses[].statusMessage statussent
statuses[].timestampTimestamp (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

KeyDescriptionExample
objectType of object that sent the eventwhatsapp_business_account
gs_app_idGupshup application ID82ed52f4-30c0-4f12-81b4-e7ad...
metadata.display_phone_numberDisplay phone number91****58
metadata.phone_number_idPhone number ID158072934066266
statuses[].conversation.idUnique conversation ID3dabdf65abaf1cbbf85217d232cce91f
statuses[].idWhatsApp message ID (wamid)wamid.HBgMOTE5MTYz...
statuses[].recipient_idDestination phone number91*****3
statuses[].statusMessage statusdelivered
statuses[].timestampTimestamp (in seconds) for delivery1710930462

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

KeyDescriptionExample
objectType of object that sent the eventwhatsapp_business_account
gs_app_idGupshup application ID82ed52f4-30c0-4f12-81b4-e7ad...
metadata.display_phone_numberDisplay phone number91*****8
metadata.phone_number_idPhone number ID158072934066266
statuses[].idWhatsApp message ID (wamid)wamid.HBgMOTE5MTYz...
statuses[].recipient_idDestination phone number91****73
statuses[].statusMessage statusread
statuses[].timestampTimestamp for the "read" status1720779817

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

KeyDescriptionExample
objectType of object that sent the eventwhatsapp_business_account
gs_app_idGupshup application ID82ed52f4-30c0-4f12-81b4-e7ad...
metadata.display_phone_numberDisplay phone number91*******8
metadata.phone_number_idPhone number ID158072934066266
statuses[].errors[].codeError code131047
statuses[].errors[].titleError title"Message failed to send..."
statuses[].idWhatsApp message ID (wamid)wamid.HBgMOTE3OTgwODkwOTc4FQIAERgSNERF...
statuses[].recipient_idDestination phone number91*******8
statuses[].statusMessage statusfailed
statuses[].timestampTimestamp of message failure1710941507

V3 Incoming Media Messages Event

Video

{
  "entry": [
    {
      "changes": [
        {
          "field": "messages",
          "value": {
            "contacts": [
              {
                "profile": {
                  "name": "Avadhoot Yadav"
                },
                "user_id": "IN.35081637581480220",
                "wa_id": "917506080480"
              }
            ],
            "messages": [
              {
                "from": "917506080480",
                "from_user_id": "IN.35081637581480220",
                "id": "wamid.HBgMOTE3NTA2MDgwNDgwFQIAEhgUM0E0MkM5RjE2RkRBRjQzRDRGMDEA",
                "timestamp": "1782372987",
                "type": "video",
                "video": {
                  "id": "1791860341777005",
                  "mime_type": "video/mp4",
                  "sha256": "zCYvqunwILzc9sXt3/2HyNYWv0L0V7WfXe5a0gqn8t0=",
                  "url": "https://filemanager.gupshup.io/wa/07c7c72d-20e3-4ff9-a5a1-14d1186eeec8/wa/media/1791860341777005?download=false"
                }
              }
            ],
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "917835039205",
              "phone_number_id": "105523045970845"
            }
          }
        }
      ],
      "id": "116676371511027"
    }
  ],
  "gs_app_id": "07c7c72d-20e3-4ff9-a5a1-14d1186eeec8",
  "object": "whatsapp_business_account"
}

Payload Description

KeyDescriptionExample
typeType of object that sent the eventvideo
gs_app_idGupshup application ID07c7c72d-20e3-4ff9-a5a1-14d1186eeec8
messaging_productMessaging productwhatsapp
contacts[].profile.nameName of the contactAvadhoot Yadav
contacts[].user_idUser ID of the contactIN.35081637581480220
contacts[].wa_idWhatsApp ID of the contact917506080480
messages[].fromSender's phone number917506080480
messages[].from_user_idSender's user IDIN.35081637581480220
messages[].idMessage ID (wamid)wamid.HBgMOTE3NTA2MDgwNDgwFQIAEhgUM0E0MkM5RjE2RkRBRjQzRDRGMDEA
messages[].timestampTime when message was sent (seconds)1782372987
messages[].typeType of message contentvideo
messages[].video.idVideo ID1791860341777005
messages[].video.mime_typeVideo MIME typevideo/mp4
messages[].video.sha256Video SHA256 hashzCYvqunwILzc9sXt3/2HyNYWv0L0V7WfXe5a0gqn8t0=
messages[].video.urlVideo URLhttps://filemanager.gupshup.io/wa/07c7c72d-20e3-4ff9-a5a1-14d1186eeec8/wa/media/1791860341777005?download=false
metadata.display_phone_numberDisplay phone number917835039205
metadata.phone_number_idPhone number ID105523045970845
entry[].changes[].fieldField that changedmessages
entry[].idAccount ID116676371511027
objectObject typewhatsapp_business_account

Audio

{
  "entry": [
    {
      "changes": [
        {
          "field": "messages",
          "value": {
            "contacts": [
              {
                "profile": {
                  "name": "Avadhoot Yadav"
                },
                "user_id": "IN.35081637581480220",
                "wa_id": "917506080480"
              }
            ],
            "messages": [
              {
                "audio": {
                  "id": "3609461882553011",
                  "mime_type": "audio/ogg; codecs=opus",
                  "sha256": "wua6L0gsWIGhTqM0SxPYpfcT2rkJrvRB0lpqI+cpISo=",
                  "url": "https://filemanager.gupshup.io/wa/07c7c72d-20e3-4ff9-a5a1-14d1186eeec8/wa/media/3609461882553011?download=false",
                  "voice": true
                },
                "from": "917506080480",
                "from_user_id": "IN.35081637581480220",
                "id": "wamid.HBgMOTE3NTA2MDgwNDgwFQIAEhgUM0E2QjQ5NUUyMUZDQzg2MDJEMjEA",
                "timestamp": "1782372953",
                "type": "audio"
              }
            ],
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "917835039205",
              "phone_number_id": "105523045970845"
            }
          }
        }
      ],
      "id": "116676371511027"
    }
  ],
  "gs_app_id": "07c7c72d-20e3-4ff9-a5a1-14d1186eeec8",
  "object": "whatsapp_business_account"
}

Payload Description

KeyDescriptionExample
typeType of object that sent the eventaudio
gs_app_idGupshup application ID07c7c72d-20e3-4ff9-a5a1-14d1186eeec8
messaging_productMessaging productwhatsapp
contacts[].profile.nameName of the contactAvadhoot Yadav
contacts[].user_idUser ID of the contactIN.35081637581480220
contacts[].wa_idWhatsApp ID of the contact917506080480
messages[].fromSender's phone number917506080480
messages[].from_user_idSender's user IDIN.35081637581480220
messages[].idMessage ID (wamid)wamid.HBgMOTE3NTA2MDgwNDgwFQIAEhgUM0E2QjQ5NUUyMUZDQzg2MDJEMjEA
messages[].timestampTime when message was sent (seconds)1782372953
messages[].typeType of message contentaudio
messages[].audio.idAudio ID3609461882553011
messages[].audio.mime_typeAudio MIME typeaudio/ogg; codecs=opus
messages[].audio.sha256Audio SHA256 hashwua6L0gsWIGhTqM0SxPYpfcT2rkJrvRB0lpqI+cpISo=
messages[].audio.urlAudio URLhttps://filemanager.gupshup.io/wa/07c7c72d-20e3-4ff9-a5a1-14d1186eeec8/wa/media/3609461882553011?download=false
messages[].audio.voiceWhether this is a voice messagetrue
metadata.display_phone_numberDisplay phone number917835039205
metadata.phone_number_idPhone number ID105523045970845
entry[].changes[].fieldField that changedmessages
entry[].idAccount ID116676371511027
objectObject typewhatsapp_business_account

Image

{
  "entry": [
    {
      "changes": [
        {
          "field": "messages",
          "value": {
            "contacts": [
              {
                "profile": {
                  "name": "Avadhoot Yadav"
                },
                "user_id": "IN.35081637581480220",
                "wa_id": "917506080480"
              }
            ],
            "messages": [
              {
                "from": "917506080480",
                "from_user_id": "IN.35081637581480220",
                "id": "wamid.HBgMOTE3NTA2MDgwNDgwFQIAEhgUM0FGQkI0QTUyM0NCNjlCMkNBNkMA",
                "image": {
                  "id": "1751740922668458",
                  "mime_type": "image/jpeg",
                  "sha256": "nH77thkhdX34LtswPHcKJJIViehvFyEQkfM2kaDO/oI=",
                  "url": "https://filemanager.gupshup.io/wa/07c7c72d-20e3-4ff9-a5a1-14d1186eeec8/wa/media/1751740922668458?download=false"
                },
                "timestamp": "1782372910",
                "type": "image"
              }
            ],
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "917835039205",
              "phone_number_id": "105523045970845"
            }
          }
        }
      ],
      "id": "116676371511027"
    }
  ],
  "gs_app_id": "07c7c72d-20e3-4ff9-a5a1-14d1186eeec8",
  "object": "whatsapp_business_account"
}

Payload Description

KeyDescriptionExample
typeType of object that sent the eventimage
gs_app_idGupshup application ID07c7c72d-20e3-4ff9-a5a1-14d1186eeec8
messaging_productMessaging productwhatsapp
contacts[].profile.nameName of the contactAvadhoot Yadav
contacts[].user_idUser ID of the contactIN.35081637581480220
contacts[].wa_idWhatsApp ID of the contact917506080480
messages[].fromSender's phone number917506080480
messages[].from_user_idSender's user IDIN.35081637581480220
messages[].idMessage ID (wamid)wamid.HBgMOTE3NTA2MDgwNDgwFQIAEhgUM0FGQkI0QTUyM0NCNjlCMkNBNkMA
messages[].timestampTime when message was sent (seconds)1782372910
messages[].typeType of message contentimage
messages[].image.idImage ID1751740922668458
messages[].image.mime_typeImage MIME typeimage/jpeg
messages[].image.sha256Image SHA256 hashnH77thkhdX34LtswPHcKJJIViehvFyEQkfM2kaDO/oI=
messages[].image.urlImage URLhttps://filemanager.gupshup.io/wa/07c7c72d-20e3-4ff9-a5a1-14d1186eeec8/wa/media/1751740922668458?download=false
metadata.display_phone_numberDisplay phone number917835039205
metadata.phone_number_idPhone number ID105523045970845
entry[].changes[].fieldField that changedmessages
entry[].idAccount ID116676371511027
objectObject typewhatsapp_business_account

Document

{
  "entry": [
    {
      "changes": [
        {
          "field": "messages",
          "value": {
            "contacts": [
              {
                "profile": {
                  "name": "Avadhoot Yadav"
                },
                "user_id": "IN.35081637581480220",
                "wa_id": "917506080480"
              }
            ],
            "messages": [
              {
                "document": {
                  "filename": "demo.docx",
                  "id": "1046654134600113",
                  "mime_type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
                  "sha256": "JpMp/HrlSz8omzrFLv3jh+3C5WbvmkjWN+hBAix+Dqs=",
                  "url": "https://filemanager.gupshup.io/wa/07c7c72d-20e3-4ff9-a5a1-14d1186eeec8/wa/media/1046654134600113?download=false&fileName=demo.docx"
                },
                "from": "917506080480",
                "from_user_id": "IN.35081637581480220",
                "id": "wamid.HBgMOTE3NTA2MDgwNDgwFQIAEhgUM0EwMjA2OUQzMzlDMUM3MTNFMjIA",
                "timestamp": "1782372793",
                "type": "document"
              }
            ],
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "917835039205",
              "phone_number_id": "105523045970845"
            }
          }
        }
      ],
      "id": "116676371511027"
    }
  ],
  "gs_app_id": "07c7c72d-20e3-4ff9-a5a1-14d1186eeec8",
  "object": "whatsapp_business_account"
}

Payload Description

KeyDescriptionExample
typeType of object that sent the eventdocument
gs_app_idGupshup application ID07c7c72d-20e3-4ff9-a5a1-14d1186eeec8
messaging_productMessaging productwhatsapp
contacts[].profile.nameName of the contactAvadhoot Yadav
contacts[].user_idUser ID of the contactIN.35081637581480220
contacts[].wa_idWhatsApp ID of the contact917506080480
messages[].fromSender's phone number917506080480
messages[].from_user_idSender's user IDIN.35081637581480220
messages[].idMessage ID (wamid)wamid.HBgMOTE3NTA2MDgwNDgwFQIAEhgUM0EwMjA2OUQzMzlDMUM3MTNFMjIA
messages[].timestampTime when message was sent (seconds)1782372793
messages[].typeType of message contentdocument
messages[].document.filenameDocument filenamedemo.docx
messages[].document.idDocument ID1046654134600113
messages[].document.mime_typeDocument MIME typeapplication/vnd.openxmlformats-officedocument.wordprocessingml.document
messages[].document.sha256Document SHA256 hashJpMp/HrlSz8omzrFLv3jh+3C5WbvmkjWN+hBAix+Dqs=
messages[].document.urlDocument URLhttps://filemanager.gupshup.io/wa/07c7c72d-20e3-4ff9-a5a1-14d1186eeec8/wa/media/1046654134600113?download=false&fileName=demo.docx
metadata.display_phone_numberDisplay phone number917835039205
metadata.phone_number_idPhone number ID105523045970845
entry[].changes[].fieldField that changedmessages
entry[].idAccount ID116676371511027
objectObject typewhatsapp_business_account

Updated about 1 month ago

Did this page help you?