API reference

Webhook API versioning

Webhook payloads are versioned by date. Each event carries api_version, e.g. 2026-07-01. Within a version, changes are only ever additive — new fields, new event types. Anything that could break a parser (removing a field, changing a type) ships as a new version you opt into deliberately.

2 min read

YYYY-MM-DDVersion format
AdditiveIn-version guarantee
Opt-inUpgrade model

What "additive" means

Inside one api_version you may see new fields appear on data.object and new event types in the catalogue. You will never see an existing field removed, renamed or change type. Parse defensively — read the fields you need, ignore the rest — and additive change never breaks you.

Pinning and upgrading

An endpoint is pinned to the API version current when it was created. Upgrade explicitly once you have tested the new payloads against a sandbox endpoint. Because upgrades are opt-in, a new version can never silently reshape production traffic.

Frequently asked questions

What happens if I never upgrade?

Your endpoint keeps receiving its pinned version indefinitely. Versions are supported long-term; you upgrade on your own schedule.

How do I know a new version exists?

New versions are announced in the developer changelog with a migration note describing exactly which fields or types changed.

Funding for UK limited companies

Credicorp lends to your company, not to you personally — short-term working capital with no personal guarantee. See what your business could access.