Skip to main content

Send Message

Introduction to Message Send Webhook Events​

This section describes the webhook events that are specific to the message sending process in the Send Message system. These events provide detailed information about each step of the shipping process, from start to completion or error occurrence.

Events​

send.message:START​

Structure​

Indicates the start of the message sending process. This event is crucial to signal the start of sending a message queue.
{
   "event": "send.message:START", // Event name
   "data": { // Send queue details
     "queue": {
       "queueId": "78e37ede-32d9-4636-83f0-39469daf89f6", // Queue identifier
       "status": "STARTED", // Queue status
       "progress": 0 // Send progress
     }
   },
   "instance": { // Instance details
     "owner": "[email protected]",
     "name": "codechat",
     "id": "d4a58666-9737-485d-988b-d18a43ce8c75"
   }
}

send.message:PROCESSING​

Structure​

Informs about message sending processing, showing progress from 0 to 100%.
{
   "event": "send.message:PROCESSING", // Event name
   "data": { // Processing details
     "queue": {
       "messageId": "BAE58965172ED18B", // Message identifier
       "progress": 67, // Send progress
       "queueId": "78e37ede-32d9-4636-83f0-39469daf89f6",
       "queueTimestamp": 1672004593497 // Queue timestamp
     }
   },
   "instance": { // Instance details
     "owner": "[email protected]",
     "name": "codechat",
     "id": "d4a58666-9737-485d-988b-d18a43ce8c75"
   }
}

send.message:COMPLETED​

Structure​

Notifies the completion of the message sending process.
{
   "event": "send.message:COMPLETED", // Event name
   "data": { // Completed submission details
     "queue": {
       "queueId": "78e37ede-32d9-4636-83f0-39469daf89f6",
       "progress": 100, // Send progress
       "data": { // Shipping data
         "jids": [
           "[email protected]",
           "[email protected]",
           "[email protected]"
         ],
         "message": {
           "messageType": "extendedTextMessage",
           "message": {
             "text": "hi"
           }
         },
         "messageIds": [
           "BAESGT65172ED24G",
           "LGMI5Y6I4W5IT5YI",
           "CFGF56ERTG8R5TRF"
         ]
       },
       "queueTimestamp": 1672004593500
     }
   },
   "instance": { // Instance details
     "owner": "[email protected]",
     "name": "codechat",
     "id": "d4a58666-9737-485d-988b-d18a43ce8c75"
   }
}

send.message:ERROR​

Structures​

Notifies you when errors occur during the submission process, such as invalid numbers or quote messages not found.
// Notifies when a number is not a valid WhatsApp contact
{
   "number": "[email protected]",
   "message": "The number entered is not a valid whatsapp contact",
   "status": 404,
   "error": "Not Found",
   "queueId": "78e37ede-32d9-4636-83f0-39469daf89f6"
}
// Notifies when a quote message is not found
{
   "message": "Message ID: BAESGT65172ED24G - not found to be quoted",
   "status": 400,
   "error": "Bad Request",
}