Webhooks
Subscribe to event notifications instead of polling.
Webhook subscriptions let you receive event notifications at your own endpoint instead of polling. Currently supported event types: kyc.
- List webhook subscriptions — your active subscriptions.
- Create webhook subscription — register a delivery URL for an event type.
- Delete webhook subscription — remove a subscription by id.
- Send test webhook: deliver a sample event to a subscription's callback URL to verify your integration.
API version pinning
A subscription is pinned to the Partner API version whose endpoint created it, and the links object in every payload it delivers is built at that version: a subscription created through the v1 create endpoint emits /v1/... links and keeps doing so after newer API versions ship. The pinned version is reported as api_version on the create and list responses.
When your financial institution migrates to a new Partner API version, make both switches together:
- Point your API calls at the new version's base URL.
- Re-create your webhook subscriptions through the new version's create endpoint, then delete the old subscriptions.
Skipping either switch leaves you receiving links built for the version you left.
New to the API? Start with the Overview for the authentication, data format, and pagination conventions that apply across every endpoint.
Get Trading Period Detail
Requires the `read:user` scope. Returns the trading-period detail for the given id, including per-product totals.
List Webhook Subscriptions
Requires the `manage:webhooks` scope. Returns the financial institution's active webhook subscriptions. Disabled (unsubscribed) subscriptions are hidden, so a subscription a partner has deleted does not reappear in the list.