Mercury: Webhooks schemas
7 Mercury schemas with complete fields and constraints.
← Webhooks operations · All schemas
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
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 |
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
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 |
Get webhook endpoints — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | API response for listing webhook endpoints with pagination |
page | object | Required within parent | Pagination information including cursors for navigating to next/previous pages |
page.nextPage | string | Optional | ID for the webhook Format: uuid |
page.previousPage | string | Optional | ID for the webhook Format: uuid |
webhooks | array | Required within parent | List of webhooks in the current page |
webhooks[] | Model | Each item | Expand Get webhook endpoint by ID — response body |
Referenced models: Get webhook endpoint by ID — response body
Update an existing webhook endpoint — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for updating an existing webhook endpoint. All fields are optional - only provided fields will be updated. Additional keys: not allowed |
eventTypes | JSON | Optional | |
eventTypes (anyOf 1) | array | Alternative | Event types to subscribe to. Send null to subscribe to all event types. Send an array to subscribe to specific types. Omit to leave unchanged. |
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 | Resource field paths to filter events by. When specified, webhook events will only be sent when one of these fields changes. Send null for no filtering. Send an array to filter by specific fields. Omit to leave unchanged. |
filterPaths (anyOf 1)[] | Model | Each item | Expand Create a new webhook endpoint — request body — body filter Paths array item |
filterPaths (anyOf 2) | null | Alternative | |
status | JSON | Optional | |
status (anyOf 1) | JSON | Alternative | |
status (anyOf 1) (allOf 1) | string | All variants apply | One of: active, paused |
status (anyOf 1) (allOf 2) | JSON | All variants apply | Webhook status. Only 'active' and 'paused' values are allowed. Omit to leave unchanged. |
status (anyOf 2) | null | Alternative | |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | The URL to which webhook events will be delivered. Omit to leave unchanged. |
url (anyOf 2) | null | Alternative |
Referenced models: Create a new webhook endpoint — request body — body filter Paths array item
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 |