Subscribe to Admin Action Events (SSE)
GET {{baseUrl}}/v2beta1/events/admin-actions
The Events API provides event push as well as historical queries via SSE (server sent events).
This endpoint streams events related to administrative actions performed by our systems.
Historical events are streamed immediately if queried, and updates are pushed as events occur.
Query Params Rules:
- since required if until specified
- since_id required if until_id specified
- since and since_id can’t be used at the same time
Behavior:
- if since or since_id not specified this will not return any historic data
- if until or until_id reached stream will end (status 200)
Warning: Currently OAS-3 doesn't have full support for representing SSE style responses from an API.
In case the client code is generated from this OAS spec, don't specify a since and until there is a good chance the generated clients will hang forever waiting for the response to end.
If you require the streaming capabilities we recommend not using the generated clients for this specific endpoint until the OAS-3 standards come to a consensus on how to represent this behavior in OAS-3.
Event Types
- LegacyNote: Old free text based admin notes
- Liquidation: Event for a position liquidation which initialized by an admin
- TransactionCancel: Event for a manually cancelled transaction
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
since | string | Format: RFC3339 or YYYY-MM-DD | |
until | string | Format: RFC3339 or YYYY-MM-DD | |
since_id | string | ||
until_id | string |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"event_id":"ve","at":"1996-06-28T02:47:30.164Z","belongs_to":{"kind":"account","id_reference":"officia reprehenderit Ut"},"created_by":{"kind":"admin","id_reference":"ut esse officia aliquip consectetur"},"type":"legacy_note_admin_event","category":"order","visibility":"correspondent_only","note":"officia nisi dolore","correspondent":"Excepteur commodo","context":{},"replaces_event_id":"aliquip dolore"},{"event_id":"cupidatat ullamco cillum enim","at":"2009-08-20T06:46:16.783Z","belongs_to":{"kind":"account","id_reference":"pariatur nostrud enim anim"},"created_by":{"kind":"admin","id_reference":"adipisicing"},"type":"transaction_cancel_admin_event","category":"order","visibility":"correspondent_only","note":"do labore","correspondent":"laborum labore ut magna","context":{},"replaces_event_id":"ea in voluptate ut"}]