Mercury: Create a new webhook endpoint
Mercury webhooks.createWebhook: arguments, response, policy and SDK examples.
← Webhooks operations · Get started
Operation mercury.createwebhook
Provider route: POST /webhooks. 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"]["createWebhook"]>[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.createWebhook(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.create_webhook(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Optional | Expand Create a new webhook endpoint — request body — body |
Referenced models: Create a new 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 |
|---|---|---|---|
$ | Model | Root | Expand Get webhook endpoint by ID — response body |
Referenced models: Get webhook endpoint by ID — response body
Schemas
Section titled “Schemas”Get webhook endpoint by ID — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Webhook configuration details |
createdAt | JSON | Required within parent | |
createdAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
createdAt (allOf 2) | JSON | All variants apply | When the webhook was created |
eventTypes | JSON | Optional | |
eventTypes (anyOf 1) | array | Alternative | Optional array of event types this webhook is subscribed to. Nothing means all events. |
eventTypes (anyOf 1)[] | string | Each item | Known values: transaction.created, transaction.updated, checkingAccount.balance.updated, savingsAccount.balance.updated, treasuryAccount.balance.updated, investmentAccount.balance.updated, creditAccount.balance.updated |
eventTypes (anyOf 2) | null | Alternative | |
filterPaths | JSON | Optional | |
filterPaths (anyOf 1) | array | Alternative | Optional array of resource field paths to filter events by. Nothing means no filtering. |
filterPaths (anyOf 1)[] | Model | Each item | Expand Get webhook endpoint by ID — response body — filter Paths array item |
filterPaths (anyOf 2) | null | Alternative | |
id | JSON | Required within parent | |
id (allOf 1) | string | All variants apply | ID for the webhook Format: uuid |
id (allOf 2) | JSON | All variants apply | Unique identifier for the webhook endpoint |
secret | JSON | Optional | |
secret (anyOf 1) | string | Alternative | Webhook signing secret. Only returned on creation (POST), not on GET or UPDATE operations. |
secret (anyOf 2) | null | Alternative | |
status | JSON | Required within parent | |
status (allOf 1) | string | All variants apply | The status of the webhook endpoint. 'active': delivering events normally. 'paused': paused by the user. 'disabled': automatically disabled by the system due to consecutive delivery failures. A disabled webhook can be reactivated by updating its status to 'active'. Known values: active, paused, disabled |
status (allOf 2) | JSON | All variants apply | Current status of the webhook (active, paused, or disabled) |
updatedAt | JSON | Required within parent | |
updatedAt (allOf 1) | string | All variants apply | Format: yyyy-mm-ddThh:MM:ssZ |
updatedAt (allOf 2) | JSON | All variants apply | When the webhook was last updated |
url | string | Required within parent | The URL that will receive webhook POST requests |
Referenced models: Get webhook endpoint by ID — response body — filter Paths array item
Create a new webhook endpoint — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for creating a new webhook endpoint Additional keys: not allowed |
eventTypes | JSON | Optional | |
eventTypes (anyOf 1) | array | Alternative | Optional array of event types to subscribe to. Nothing means subscribe to all event types. |
eventTypes (anyOf 1)[] | string | Each item | One of: transaction.created, transaction.updated, checkingAccount.balance.updated, savingsAccount.balance.updated, treasuryAccount.balance.updated, investmentAccount.balance.updated, creditAccount.balance.updated |
eventTypes (anyOf 2) | null | Alternative | |
filterPaths | JSON | Optional | |
filterPaths (anyOf 1) | array | Alternative | Optional array of resource field paths to filter events by. When specified, webhook events will only be sent when one of these fields changes. Nothing means no filtering (all events are sent). |
filterPaths (anyOf 1)[] | Model | Each item | Expand Create a new webhook endpoint — request body — body filter Paths array item |
filterPaths (anyOf 2) | null | Alternative | |
url | string | Required within parent | The URL to which webhook events will be delivered |
Referenced models: Create a new webhook endpoint — request body — body filter Paths array item
Get webhook endpoint by ID — response body — filter Paths array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | Known values: transaction.amount, transaction.bankDescription, transaction.categoryData, transaction.customCategory, transaction.customCategory.id, transaction.customCategory.name, transaction.mercuryCategory, transaction.estimatedDeliveryDate, transaction.externalMemo, transaction.failedAt, transaction.note, transaction.postedAt, transaction.reasonForFailure, transaction.status, checkingAccount.availableBalance, checkingAccount.currentBalance, checkingAccount.inFlightBalance, savingsAccount.availableBalance, savingsAccount.currentBalance, savingsAccount.inFlightBalance, treasuryAccount.availableBalance, treasuryAccount.currentBalance, treasuryAccount.inFlightBalance, investmentAccount.availableBalance, investmentAccount.currentBalance, investmentAccount.inFlightBalance, creditAccount.availableBalance, creditAccount.currentBalance, creditAccount.inFlightBalance |
Create a new webhook endpoint — request body — body filter Paths array item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | string | Root | One of: transaction.amount, transaction.bankDescription, transaction.categoryData, transaction.customCategory, transaction.customCategory.id, transaction.customCategory.name, transaction.mercuryCategory, transaction.estimatedDeliveryDate, transaction.externalMemo, transaction.failedAt, transaction.note, transaction.postedAt, transaction.reasonForFailure, transaction.status, checkingAccount.availableBalance, checkingAccount.currentBalance, checkingAccount.inFlightBalance, savingsAccount.availableBalance, savingsAccount.currentBalance, savingsAccount.inFlightBalance, treasuryAccount.availableBalance, treasuryAccount.currentBalance, treasuryAccount.inFlightBalance, investmentAccount.availableBalance, investmentAccount.currentBalance, investmentAccount.inFlightBalance, creditAccount.availableBalance, creditAccount.currentBalance, creditAccount.inFlightBalance |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: mercury.createwebhook. Catalog operation: mercury:createWebhook. 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.