Mercury: Events schemas
3 Mercury schemas with complete fields and constraints.
← Events operations · All schemas
Get all events — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Paginated response containing a list of API events. | Use the page cursor information to fetch additional pages of events. |
events | array | Required within parent | List of events in the current page |
events[] | Model | Each item | Expand Get event by ID — response body |
page | object | Required within parent | Pagination information including cursors for navigating to next/previous pages |
page.nextPage | string | Optional | ID for the API event Format: uuid |
page.previousPage | string | Optional | ID for the API event Format: uuid |
Referenced models: Get event by ID — response body
Get event by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single event in the Mercury API event stream. Events track changes to resources over time, providing an audit trail of all modifications with before/after values and metadata about what changed. |
changedPaths | array | Required within parent | List of JSON paths that were modified in this event |
changedPaths[] | string | Each item | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the API event Format: uuid |
id (allOf 2) | JSON | All variants apply | Unique identifier for this event |
mergePatch | object | Required within parent | JSON object containing the fields that were changed and their new values |
occurredAt | JSON | Required within parent | |
occurredAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
occurredAt (allOf 2) | JSON | All variants apply | Timestamp when the event occurred |
operationType | JSON | Required within parent | |
operationType (allOf 1) | string | All variants apply | Known values: create, update, delete |
operationType (allOf 2) | JSON | All variants apply | The type of operation performed (e.g., create, update, delete) |
previousValues | JSON | Optional | |
previousValues (anyOf 1) | object | Alternative | JSON object containing the fields that were changed and their previous values before the update |
previousValues (anyOf 2) | null | Alternative | |
resourceId | JSON | Required within parent | |
resourceId (allOf 1) | string | All variants apply | Format: uuid |
resourceId (allOf 2) | JSON | All variants apply | The ID of the resource that was affected |
resourceType | JSON | Required within parent | |
resourceType (allOf 1) | string | All variants apply | Known values: transaction, checkingAccount, savingsAccount, treasuryAccount, investmentAccount, creditAccount |
resourceType (allOf 2) | JSON | All variants apply | The type of resource that was affected (e.g., transaction, account) |
resourceVersion | JSON | Required within parent | |
resourceVersion (allOf 1) | Model | All variants apply | Expand Get event by ID — response body — resource Version value |
resourceVersion (allOf 2) | JSON | All variants apply | Version number of the resource after this change |
Referenced models: Get event by ID — response body — resource Version value
Get event by ID — response body — resource Version value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | integer | Alternative | Format: int64 Minimum: 1 |
$ (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |