Skip to main content
POST
Create a webhook subscription

Authorizations

Authorization
string
header
required

First-party access token for your own signed-in session, obtained from the /api/enterprise-auth/login endpoint. The REST API returns your own account data to you — it is a first-party consumer surface, not a third-party integration channel. Data from connected bank feeds (open-banking / CDR data) is your own data, returned only to you in your own authenticated session.

Body

application/json
url
string<uri>
required

https:// on port 443, a DNS name (no IP literal or local/internal host), at most 2048 characters. Every address the name resolves to must be public.

events
enum<string>[]
required
Minimum array length: 1
Available options:
transaction.categorized,
expense.created,
receipt.processed

Must be true: show the consent text (from the list endpoint) to the person first.

fieldFilter
enum<string>[]

Extra fields to include beyond the base fields.

Available options:
description,
reference,
notes
description
string
Maximum string length: 200

Response

Created

success
boolean
subscription
object
secret
string

The signing secret (whsec_ + 64 hex). Returned only here.