Snowplow Data Structures
Publishing your tracking plan to Snowplow Data Structures
Introduction
The Snowplow integration (opens in a new tab) enables you to publish your Avo Tracking Plan into Snowplow. You can configure the integration to publish whenever a branch is merged or with a push of a button.
Configure the Snowplow integration
To enable the direct integration with Snowplow, you need to configure it with the following parameters.
- Snowplow Organization ID: Your organization ID issued by Snowplow, can be retrieved from the URL immediately following the
.com
when visiting the console, e.g.13bbade6-1eff-42d0-861d-41cd3e52ac41
inhttps://console.snowplowanalytics.com/13bbade6-1eff-42d0-861d-41cd3e52ac41/contact-us
. - Snowplow Vendor Name: The vendor name of your Snowplow schemas, can be obtained in the
Manage data structures
section in the console. - Snowplow Access Token: The secret access token to update your Snowplow data structures, can be obtained in the
API keys
section.
Publishing to Snowplow
Data structures interfaces are only compatible with pipelines that have been upgraded to use Iglu Server registries, rather than static S3 registries. Please check in your Snowplow console (opens in a new tab), to see if you need an upgrade or if your registries are ready to go.
The Snowplow API enforces a workflow of validating, testing on development and then deploying to production.
Avo publishing integration will take care of validating and deploying your data structures to the development environment, where you take over to test the data structures and promote the tested data structures to production.
Avo will override all events in the Snowplow Tracking Plan that are being imported from Avo. Any changes made to an event in Snowplow Tracking Plan between Avo publish will be overridden on next Avo publish.
Avo will not override any events that are only defined in Snowplow, or events that have not been excluded from the Snowplow integration in Avo with filters.
Note that only Admin users can promote data structures from Dev to Production. Learn more on how to promote the data structures with Snowplow Console here (opens in a new tab)
Versioning
Avo will create new data structures with version 1-0-0 and will patch the existing data structures in your development environment on the same version as they are.
When promoting the tested data structures to production you will be required update the version. Read more about the versioning here (opens in a new tab)