Skip to main content

Queue Manager

Introduction to Queue Management Webhook Events​

This section covers webhook events that are specific to managing queues in the Queue Manager system. These events are crucial for controlling message queue processing, including pausing, resuming, and deleting queues.

Events​

paused.queue​

Structure​

This event is used to pause processing of a queue. It is useful for controlling the message processing flow in specific situations.
{
   "event": "paused.queue", // Event name
   "data": { // Action details
     "action": "pause", // Action performed
     "queue": { // Queue details
       "queueId": "78e37ede-32d9-4636-83f0-39469daf89f6", // Queue identifier
       "progress": 43, // Queue progress
       "data": { // Queue data
         "messageType": "extendedTextMessage",
         "message": {
           "text": "hi"
         }
       },
       "queueTimestamp": 1672004593500 // Queue timestamp
     }
   },
   "instance": { // Instance details
     "owner": "[email protected]",
     "name": "codechat",
     "id": "d4a58666-9737-485d-988b-d18a43ce8c75"
   }
}

summarized.queue​

Structure​

This event signals the resumption of processing of a queue. It is essential to restart processing after a pause.
{
   "event": "summed.queue", // Event name
   "data": { // Action details
     "action": "resume", // Action performed
     "queue": { // Queue details
       "queueId": "78e37ede-32d9-4636-83f0-39469daf89f6",
       "progress": 43,
       "date": {
         "jids": [
           "[email protected]",
           "[email protected]",
           "[email protected]"
         ]
       },
       "queueTimestamp": 1672004593500
     }
   },
   "instance": { // Instance details
     "owner": "[email protected]",
     "name": "codechat",
     "id": "d4a58666-9737-485d-988b-d18a43ce8c75"
   }
}

deleted.queue​

Structure​

This event is used to delete a queue. It is vital for managing queues that are no longer needed or that need to be removed for any reason.
{
   "event": "deleted.queue", // Event name
   "data": { // Action details
     "action": "delete", // Action performed
     "queue": { // Queue details
       "queueId": "78e37ede-32d9-4636-83f0-39469daf89f6",
       "progress": 95,
       "date": {
         "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"
   }
}