Mercury: Get event by ID
Mercury events.getEvent: arguments, response, policy and SDK examples.
← Events operations · Get started
Operation mercury.getevent
Provider route: GET /events/{eventId}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/mercury with npm, or alter-sdk-mercury with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { MercuryIntegration } from "@alter-ai/mercury";
async function execute(input: Parameters<MercuryIntegration["events"]["getEvent"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new MercuryIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.events.getEvent(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_mercury import MercuryIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = MercuryIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.events.get_event(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.eventId | string | Required within parent | ID for the API event Format: uuid |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get event by ID — response body |
Referenced models: Get event by ID — response body
Schemas
Section titled “Schemas”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]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: mercury.getevent. Catalog operation: mercury:getEvent. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.