Skip to content

Mercury: Events schemas

3 Mercury schemas with complete fields and constraints.

← Events operations · All schemas

Get all events — response body

FieldTypePresenceDescription and constraints
$objectRootPaginated response containing a list of API events.
| Use the page cursor information to fetch additional pages of events.
eventsarrayRequired within parentList of events in the current page
events[]ModelEach itemExpand Get event by ID — response body
pageobjectRequired within parentPagination information including cursors for navigating to next/previous pages
page.nextPagestringOptionalID for the API event
Format: uuid
page.previousPagestringOptionalID for the API event
Format: uuid

Referenced models: Get event by ID — response body

Get event by ID — response body

FieldTypePresenceDescription and constraints
$objectRootRepresents 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.
changedPathsarrayRequired within parentList of JSON paths that were modified in this event
changedPaths[]stringEach item
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the API event
Format: uuid
id (allOf 2)JSONAll variants applyUnique identifier for this event
mergePatchobjectRequired within parentJSON object containing the fields that were changed and their new values
occurredAtJSONRequired within parent
occurredAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
occurredAt (allOf 2)JSONAll variants applyTimestamp when the event occurred
operationTypeJSONRequired within parent
operationType (allOf 1)stringAll variants applyKnown values: create, update, delete
operationType (allOf 2)JSONAll variants applyThe type of operation performed (e.g., create, update, delete)
previousValuesJSONOptional
previousValues (anyOf 1)objectAlternativeJSON object containing the fields that were changed and their previous values before the update
previousValues (anyOf 2)nullAlternative
resourceIdJSONRequired within parent
resourceId (allOf 1)stringAll variants applyFormat: uuid
resourceId (allOf 2)JSONAll variants applyThe ID of the resource that was affected
resourceTypeJSONRequired within parent
resourceType (allOf 1)stringAll variants applyKnown values: transaction, checkingAccount, savingsAccount, treasuryAccount, investmentAccount, creditAccount
resourceType (allOf 2)JSONAll variants applyThe type of resource that was affected (e.g., transaction, account)
resourceVersionJSONRequired within parent
resourceVersion (allOf 1)ModelAll variants applyExpand Get event by ID — response body — resource Version value
resourceVersion (allOf 2)JSONAll variants applyVersion 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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)integerAlternativeFormat: int64
Minimum: 1
$ (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.