• Public
  • Public/Protected
  • All

Api versions

Both events and commands have a version field that determines the version of the api for event/command. The version is a semver version, and if follows the usual semver convention:

  • PATCH version change - contains only fixes, does not change the structure of the events/commands.
  • MINOR version change - can change the structure in backward compatible manner - new fields can be added, no other structure changes are allowed.
  • MAJOR version change - can contain any breaking change.

NOTE: In order to keep your webhooks as compatible as possible to new versions don't fail on unknown fields, just ignore them.

Generated using TypeDoc