Response
Status code 202 means that the event was accepted and will be processed asynchronously, a Success response is returned.
Status code 401 means that auth has failed due to the api-key header being invalid or missing in the request, an Error response is returned.
Status code 400 means that the request payload is not valid, an Error response is returned.
The detailed documentation of the responses is available in the API specification.
Object types
Success response
| Field | Type | Required | Description |
|---|---|---|---|
| meta | Meta | Yes | Metadata of the response |
| result | object | Yes | Result details |
Error response
| Field | Type | Required | Description |
|---|---|---|---|
| type | string | Yes | Error type |
| message | string | Yes | Error message |
| details | string | No | Details about the error |
Meta
| Field | Type | Required | Description |
|---|---|---|---|
| requestId | string | Yes | Unique request ID |
Result
The result field is an empty object for now.