Error API
- DarkLight
Error API
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
API Error Event
Overview
This event is triggered when there is an error in the Acqueon Workspace while connecting to backend services or processing any messages.
Pre-requisite
The application must be registered with the channel.
Sequence Diagram
.jpg?sv=2022-11-02&spr=https&st=2025-03-01T07%3A24%3A42Z&se=2025-03-01T07%3A34%3A42Z&sr=c&sp=r&sig=1Gc4UcA2ZOamdRL%2Be3gIghjv%2BQ7KUTUJTEwayVDCA6I%3D)
Message Structure
Request Parameters | Value |
|---|---|
channel | Amazon |
topic | Error |
subtopic | ApiError |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Data Parameters
Parameter | Data Type | Description | Example Data |
|---|---|---|---|
data | JSON Object | Data object | N/A |
errorType | String | Type of error | WEBSOCKET_ERROR |
errorMessage | String | Internal error message | WebSocket connection is reconnecting |
msg | String | User friendly error message | WebSocket connection is reconnecting |
Request Parameters | Value |
|---|---|
channel | Amazon |
topic | Error |
subtopic | ApiError |
data | JSON Object |
Sample Request
{
"channel": "Amazon",
"topic": "Error",
"subtopic": "ApiError",
"data":
{
"errorType": "WEBSOCKET_ERROR",
"errorMessage": "WebSocket connection is reconnecting",
"msg": "WebSocket connection is reconnecting"
}
}Was this article helpful?