Skip to main content
POST
Create new webhook endpoint

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
url
string<uri>
required

The HTTPS URL that will receive event deliveries.

Maximum string length: 512
description
string | null

Optional label to help you identify the endpoint.

Maximum string length: 255
enabled
boolean

Whether the endpoint receives deliveries. Defaults to true.

events
enum<string>[]

The event types this endpoint should receive. Canonical names: transactions.created, transactions.updated, balance.updated, holdings.updated, account.created, account.updated, account.deleted. Legacy aliases (bank_account.created, bank_account.updated, bank_account.deleted) are accepted but cannot be mixed in the same array with their canonical counterparts.

Minimum array length: 1
Available options:
transactions.created,
transactions.updated,
balance.updated,
holdings.updated,
account.created,
account.updated,
account.deleted,
bank_account.created,
bank_account.updated,
bank_account.deleted,
connection.created,
connection.activated,
connection.reauthorized,
connection.expiring,
connection.expired,
connection.failing,
connection.recovered,
connection.disabled,
connection.deleted
financial_accounts
integer[] | null

Limit deliveries to these financial account IDs. Omit or pass null to receive events for all accounts.

type
enum<string>

WEBHOOK (default) for a standard endpoint, ZAPIER for an endpoint used with the Zapier integration, or N8N for an endpoint registered by the Synci n8n trigger node.

Available options:
WEBHOOK,
ZAPIER,
N8N
payload_version
enum<string>

Shape of payloads delivered to this endpoint. Defaults to v2 (canonical account.* event names + financial_account payload key). Pass v1 to opt into the legacy shape (bank_account.* event-type aliases + bank_account payload key) — only useful for clients migrating an existing integration. Pinned at creation; updates are ignored. If omitted, the version is inferred from the events array: any bank_account.* subscription implies v1, otherwise v2.

Available options:
v1,
v2
omit_sensitive_identifiers
any

When true, sensitive account identifiers (IBAN/BBAN) are omitted from delivered payloads. Must be true for Zapier endpoints.

Available options:
yes,
on,
1,
1,
true,
true

Response

message
string
required
Allowed value: "Webhook endpoint created."
data
WebhookEndpointResource · object
required