Mercury: Verify a webhook endpoint
Mercury webhooks.verifyWebhook: arguments, response, policy and SDK examples.
← Webhooks operations · Get started
Operation mercury.verifywebhook
Provider route: POST /webhooks/{webhookEndpointId}/verify. 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["webhooks"]["verifyWebhook"]>[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.webhooks.verifyWebhook(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.webhooks.verify_webhook(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.webhookEndpointId | string | Required within parent | ID for the webhook Format: uuid |
body | Model | Optional | Expand Verify a webhook endpoint — request body — body |
Referenced models: Verify a webhook endpoint — request body — body
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 |
|---|---|---|---|
$ | null | Root |
Schemas
Section titled “Schemas”Verify a webhook endpoint — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for verifying a webhook endpoint Additional keys: not allowed |
eventType | JSON | Optional | |
eventType (anyOf 1) | JSON | Alternative | |
eventType (anyOf 1) (allOf 1) | string | All variants apply | One of: transaction.created, transaction.updated, checkingAccount.balance.updated, savingsAccount.balance.updated, treasuryAccount.balance.updated, investmentAccount.balance.updated, creditAccount.balance.updated |
eventType (anyOf 1) (allOf 2) | JSON | All variants apply | Optional event type to test. If not specified, defaults to transaction.created. |
eventType (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: mercury.verifywebhook. Catalog operation: mercury:verifyWebhook. 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.
No-content response statuses: [204]