Skip to main content
POST
Test webhook endpoint

Authorizations

Authorization
string
header
required

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

Path Parameters

webhookEndpointId
integer
required

The webhook endpoint ID

Body

application/json
event
enum<string>
required

The event type to send to the endpoint.

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,
portal.user.verified
financial_account_id
integer | null

Optional financial account to build the test payload from. When omitted, sample data is sent instead.

Response

message
string
required
Allowed value: "Webhook test event dispatched."