requestId: The ID of the failed request. error: Error details describing what went wrong.

Event Failure Response

Triggered when an asynchronous event fails to complete.

Error Recovery

Always listen for this event to implement retry logic or alert users of a failed task.

Best practices

Include the error code in your logs for technical troubleshooting.

Asynchronous Failure

Indicates that an async operation could not be completed.

Fields

requestId: The ID of the failed request.
error: Error details describing what went wrong.

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.failed",
"payload": {
  "requestId": "req_002",
  "error": "TIMEOUT_ERROR"
  },
"me": {
  "id": "11111111111@c.us",
  "lid": "123@lid",
  "pushName": "Instance"
  }
}

Previous TopicEvent Success Response

Next TopicRaw Engine Event

Event Failure Response

Best practices

Asynchronous Failure

Fields

Expected Responses

Example

Command Palette