Skip to content

Mercury: Webhooks schemas

7 Mercury schemas with complete fields and constraints.

← Webhooks operations · All schemas

Create a new webhook endpoint — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest body for creating a new webhook endpoint
Additional keys: not allowed
eventTypesJSONOptional
eventTypes (anyOf 1)arrayAlternativeOptional array of event types to subscribe to. Nothing means subscribe to all event types.
eventTypes (anyOf 1)[]stringEach itemOne of: transaction.created, transaction.updated, checkingAccount.balance.updated, savingsAccount.balance.updated, treasuryAccount.balance.updated, investmentAccount.balance.updated, creditAccount.balance.updated
eventTypes (anyOf 2)nullAlternative
filterPathsJSONOptional
filterPaths (anyOf 1)arrayAlternativeOptional 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)[]ModelEach itemExpand Create a new webhook endpoint — request body — body filter Paths array item
filterPaths (anyOf 2)nullAlternative
urlstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$stringRootOne 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

FieldTypePresenceDescription and constraints
$objectRootWebhook configuration details
createdAtJSONRequired within parent
createdAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
createdAt (allOf 2)JSONAll variants applyWhen the webhook was created
eventTypesJSONOptional
eventTypes (anyOf 1)arrayAlternativeOptional array of event types this webhook is subscribed to. Nothing means all events.
eventTypes (anyOf 1)[]stringEach itemKnown values: transaction.created, transaction.updated, checkingAccount.balance.updated, savingsAccount.balance.updated, treasuryAccount.balance.updated, investmentAccount.balance.updated, creditAccount.balance.updated
eventTypes (anyOf 2)nullAlternative
filterPathsJSONOptional
filterPaths (anyOf 1)arrayAlternativeOptional array of resource field paths to filter events by. Nothing means no filtering.
filterPaths (anyOf 1)[]ModelEach itemExpand Get webhook endpoint by ID — response body — filter Paths array item
filterPaths (anyOf 2)nullAlternative
idJSONRequired within parent
id (allOf 1)stringAll variants applyID for the webhook
Format: uuid
id (allOf 2)JSONAll variants applyUnique identifier for the webhook endpoint
secretJSONOptional
secret (anyOf 1)stringAlternativeWebhook signing secret. Only returned on creation (POST), not on GET or UPDATE operations.
secret (anyOf 2)nullAlternative
statusJSONRequired within parent
status (allOf 1)stringAll variants applyThe 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)JSONAll variants applyCurrent status of the webhook (active, paused, or disabled)
updatedAtJSONRequired within parent
updatedAt (allOf 1)stringAll variants applyFormat: yyyy-mm-ddThh:MM:ssZ
updatedAt (allOf 2)JSONAll variants applyWhen the webhook was last updated
urlstringRequired within parentThe 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

FieldTypePresenceDescription and constraints
$stringRootKnown 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

FieldTypePresenceDescription and constraints
$objectRootAPI response for listing webhook endpoints with pagination
pageobjectRequired within parentPagination information including cursors for navigating to next/previous pages
page.nextPagestringOptionalID for the webhook
Format: uuid
page.previousPagestringOptionalID for the webhook
Format: uuid
webhooksarrayRequired within parentList of webhooks in the current page
webhooks[]ModelEach itemExpand Get webhook endpoint by ID — response body

Referenced models: Get webhook endpoint by ID — response body

Update an existing webhook endpoint — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest body for updating an existing webhook endpoint.
All fields are optional - only provided fields will be updated.
Additional keys: not allowed
eventTypesJSONOptional
eventTypes (anyOf 1)arrayAlternativeEvent 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)[]stringEach itemOne of: transaction.created, transaction.updated, checkingAccount.balance.updated, savingsAccount.balance.updated, treasuryAccount.balance.updated, investmentAccount.balance.updated, creditAccount.balance.updated
eventTypes (anyOf 2)nullAlternative
filterPathsJSONOptional
filterPaths (anyOf 1)arrayAlternativeResource 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)[]ModelEach itemExpand Create a new webhook endpoint — request body — body filter Paths array item
filterPaths (anyOf 2)nullAlternative
statusJSONOptional
status (anyOf 1)JSONAlternative
status (anyOf 1) (allOf 1)stringAll variants applyOne of: active, paused
status (anyOf 1) (allOf 2)JSONAll variants applyWebhook status. Only 'active' and 'paused' values are allowed. Omit to leave unchanged.
status (anyOf 2)nullAlternative
urlJSONOptional
url (anyOf 1)stringAlternativeThe URL to which webhook events will be delivered. Omit to leave unchanged.
url (anyOf 2)nullAlternative

Referenced models: Create a new webhook endpoint — request body — body filter Paths array item

Verify a webhook endpoint — request body — body

FieldTypePresenceDescription and constraints
$objectRootRequest body for verifying a webhook endpoint
Additional keys: not allowed
eventTypeJSONOptional
eventType (anyOf 1)JSONAlternative
eventType (anyOf 1) (allOf 1)stringAll variants applyOne 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)JSONAll variants applyOptional event type to test. If not specified, defaults to transaction.created.
eventType (anyOf 2)nullAlternative

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.