Errors¶
When returning an error response to a webhook request, the response should be returned in the format described below.
Error Response Fields¶
| Field | Type | Description |
|---|---|---|
| errorCode | Integer | The HTTP status response code |
| errorMessage | String | A message explaining the error |
Example Error Responses¶
HTTP 4xx - Client errors¶
{
"errorCode": 401,
"errorMessage": "The authorisation token is invalid"
}
HTTP 5xx - Server errors¶
{
"errorCode": 503,
"errorMessage": "The server is down for maintenance, please retry the request"
}