Versioning

Every event carries an apiVersion. The current version is 2026-08-09.

What can change without a version bump

• New fields on existing objects.
• New event types.
• New values for a field that is already documented as open-ended, such as data.previousStatus.

Your parser must tolerate all three. Rejecting an unknown field or an unrecognized type will break your integration on a routine release.

// Ignore what you do not handle, rather than failing on it.
if (event.type !== "payment.status_changed") return res.sendStatus(202);

What raises apiVersion

• Removing a field, or changing its type.
• Changing the meaning of an existing value.
• Changing the signature scheme.

Getting help

Something here wrong or missing? Get in touch.