Webhooks

Event Success Response

Triggered when an asynchronous event completes successfully.

Best practices

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

Asynchronous Success

This event confirms that a previously requested async operation has finished without errors.

Fields

  • requestId: The unique ID you received when making the initial request.
  • data: The successful result or confirmation data.

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 *
string *
object *
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

Command Palette

Search for a command to run...