About error handling
Errors from your integration are processed in a particular way so that Maxsight can identify which errors to show users and recognize those that have been handled correctly.
Note
Error responses should return with a 200 status code regardless of the error type.
Response fields
The following response can be used in any request to inform Maxsight that an error has occurred.
If there are no errors, then an empty array should be returned in the errors field.
Key | Value | Description |
|---|---|---|
*Required array | For a sample value, see the following example. | Contains zero or more |
Field details
Field | Value | Description |
|---|---|---|
*Required
| Sample value: | The type of error encountered. |
*Required string | Sample value: | A description of the error. This is shown to the user. |
Response example
{
"errors": [
{
"type": "MISSING_CHECK_INPUT",
"message": "The request is missing required fields."
}
]
}