Event Success Response

Triggered when an asynchronous event completes successfully.

Async Tracking

Essential for tracking the completion of bulk tasks or long-running operations.

Best practices

Use the `requestId` to link the result back to your initial API call.

Expected Responses

Explore all possible responses and outcomes from the server. We have documented each status code with data examples to make success and error handling easier.

Webhook Payload Example

application/json

string *

number *

string *

object *

string *

object *

Example

{
"id": "evt_01...",
"timestamp": 1634567890123,
"session": "default",
"metadata": {
  "user.id": "123",
  "user.email": "email@example.com"
  },
"engine": "WEBJS",
"event": "event.response",
"payload": {
  "requestId": "req_001",
  "data": {
    "status": "completed"
    }
  },
"me": {
  "id": "11111111111@c.us",
  "lid": "123@lid",
  "pushName": "Instance"
  }
}

Previous TopicLabel Removed from Chat

Next TopicEvent Failure Response

Event Success Response

Best practices

Expected Responses

Example

Command Palette