Events represent interactions or results of interactions in our system. They are exposed using Webhooks.
Note
Examples for events in this documentation are provided using the easier readable YAML format although they are sent JSON encoded.
Every event has a version property that contains a semantic version. At the moment we use the following version ranges:
0.0.0 for legacy events that were produced before we introduced event versioning.
1.x.x for events produced by Impact Stack 1.0
2.x.x for events produced by Impact Stack 2.0
Note
Depending on your setup and migration status, you might receive different versions of events depending on the event type. Some events are still produced by the old version of the product, while others already come from the new version.
In patch-level releases we will only make fixes to the events we send. This includes:
Fixes to the encoding of values
Rollbacks of incompatible changes that were accidentally introduced in the current minor version
Minor changes are for additions to our event types. In addition to patch-level changes they may include:
New event types
Additional keys for existing event types
Extensions to the value range of existing keys
Major versions are for backwards incompatible changes to our webhooks. Usually these will need adjustments to software that processes the events. In addition to minor-version changes this includes:
Removal of event types
Removal of event keys
All events are encoded as JSON. On top of the JSON built-in types the events can contain properties with the following data:
uuid: A hex encoded UUID
date: ISO 8601 encoded dates either with an explicit offset or in UTC, e.g. 2023-12-24T01:23:45+01:00 which equals 2023-12-24T00:23:45+00:00
interval: ISO 8601 time interval, e.g. P1M (1 month), P3M (3 months), P1Y (1 year)
float: A floating point number encoded as string like 1.23, 4.0, 5 (comma is optional).
money: Money value encoded as string of the float (see above) and the ISO 4217 currency code separated by a space e.g. 1.23 EUR, 4 GBP
If a property is described without a hint to its type it’s a string.
Each event has the following properties.
id (integer): Internal ID of the event
type: The type of event
date (date): The date for when the event was created
version: The semantic version of the event