Skip to main content
PUT
Update a webhook endpoint

Authorizations

Authorization
string
header
required

Username = your client id. Password = your client secret.

So the base64-encoded username:password described below is client_id:client_secret:

Most HTTP clients build that header for you:

Both values come from Developers → Apps → your app. The secret is shown once at creation and is prefixed oac_.

Path Parameters

webhookId
string
required

Body

application/json
url
string<uri>

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.

events
enum<string>[]

The event types this endpoint should receive. Legacy bank_account.* aliases are not available on this surface.

Minimum array length: 1
Available options:
transactions.created,
transactions.updated,
balance.updated,
holdings.updated,
account.created,
account.updated,
account.deleted,
connection.created,
connection.activated,
connection.reauthorized,
connection.expiring,
connection.expired,
connection.failing,
connection.recovered,
connection.disabled,
connection.deleted,
portal.user.verified
omit_sensitive_identifiers
boolean

When true, sensitive account identifiers (IBAN/BBAN) are omitted from delivered payloads.

financial_accounts
string
payload_version
string
type
string

Response

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