# Snowplow integration

> Snowplow BDP Console API for managing tracking pipelines, data structures, data products, event specifications, warehouse job runs, and data quality alerts.

- Authentication: apiKey

## Tools (104)

- **Batch Get Event Specification Versions**: Fetch several named event specification versions in one request
- **Batch Promote Data Structures**: Promote many data structures to production in one call, reporting per-schema outcomes
- **Check Event Specification Compatibility**: Dry-run an event specification against its source schemas and get a property-level compatibility report
- **Clone Data Product**: Duplicate a data product along with its event specifications
- **Clone Event Specification**: Duplicate an existing event specification into a new one
- **Create API Key**: Mint a new Console API key scoped to a subset of the caller's own permissions
- **Create Data Product**: Create a data product to group event specifications under one owner and domain
- **Create Data Product Data Model**: Define a warehouse data model on a data product and get back the generated SQL
- **Create Data Product From Template**: Instantiate a template into a new data product with its event specifications
- **Create Data Product Subscription**: Subscribe a recipient to change notifications for a data product
- **Create Data Quality Alert**: Set up an email or Slack alert for failed events on a pipeline
- **Create Data Structure Draft**: Save a work-in-progress data structure as a draft without deploying it
- **Create Event Specification**: Define a new event specification describing an event, its entities, and its rules
- **Create Iglu API Key**: Create a read-only or read-write API key for the dev or prod Iglu schema server
- **Create or Update Data Model**: Create a new data model or fully replace an existing one, choosing the dbt or SQL Runner shape
- **Create Signals Configuration**: Enable Signals on a pipeline, optionally attaching an existing or new destination target
- **Create Source Application**: Register a website, app, or service as a source of tracked events
- **Create User**: Invite a new user into the organization with a set of capabilities
- **Delete API Key**: Revoke a Console API key by id
- **Delete Data Product**: Delete a data product and detach its event specifications
- **Delete Data Product Data Model**: Remove a data model configuration from a data product
- **Delete Data Product Subscription**: Unsubscribe a recipient from a data product's change notifications
- **Delete Data Quality Alert**: Remove a failed-event alert or digest configuration
- **Delete Data Structure Draft**: Discard a draft data structure by schema hash
- **Delete Event Specification**: Remove an event specification from its data product
- **Delete Iglu API Key**: Revoke an Iglu schema server API key
- **Delete Signals Configuration**: Remove a Signals configuration from a pipeline
- **Delete Source Application**: Remove a source application from the organization
- **Delete User**: Remove a user from the organization
- **Deploy Data Structure**: Promote a data structure version from one environment to another, such as dev to prod
- **Generate Access Token**: Exchange the API key ID and secret for a 24-hour Bearer access token used by every other endpoint
- **Get API Key**: Retrieve one Console API key's metadata and permissions by id
- **Get Data Model**: Retrieve one data model's configuration, schedule, and change log by name
- **Get Data Product**: Retrieve one data product with its event specifications and source applications
- **Get Data Product Data Model**: Retrieve one data product data model configuration and its generated SQL
- **Get Data Product History**: List the change history of a data product with who changed what and when
- **Get Data Product Metrics**: Get event volume metrics across all data products, optionally scoped to one pipeline
- **Get Data Product Template**: Retrieve one data product template including the data product and event spec forms it defines
- **Get Data Quality Alert**: Retrieve one data quality alert with its filters, subscribers, and threshold
- **Get Data Structure**: Retrieve one data structure's vendor, name, format, metadata, and latest deployments
- **Get Data Structure Draft**: Retrieve a single draft data structure and its metadata by schema hash
- **Get Data Structure Draft Schema**: Retrieve the JSON schema body of a single draft data structure
- **Get Data Structure Version**: Retrieve the JSON schema body of one specific version of a data structure
- **Get Email Subscriptions**: Get the per-pipeline email recipient lists for pipeline alerting and digest notifications
- **Get Event Specification**: Retrieve one event specification by id, optionally with its full change history
- **Get Event Specification History**: List the change history of an event specification with who changed what and when
- **Get Event Specification Metrics**: Get tracking volume metrics across event specifications, optionally scoped to one pipeline
- **Get Event Specification Version Metrics**: Get tracking volume broken down by version for one event specification
- **Get Failed Event Details**: Retrieve the full detail of one failed event error on a pipeline
- **Get Iglu Configuration**: Get the dev and prod Iglu schema server endpoints and their API keys
- **Get Job Run**: Retrieve a single warehouse job run including its step list
- **Get Job Run Step**: Retrieve one step of a job run including its stdout and error output
- **Get Mini**: Retrieve one Snowplow Mini instance's status and configuration
- **Get Pipeline**: Retrieve one pipeline's status, cluster placement, and collector configuration
- **Get Slack Integration**: Check whether the organization has connected Slack for data quality alerts
- **Get Source Application**: Retrieve one source application including its app ids and default entities
- **Get User**: Retrieve a single organization user by id, including their capabilities
- **Initiate Slack Connection**: Get the Slack install URL a person must open to connect Slack for alerting
- **List API Keys**: List the organization's Console API keys with their permissions and last-used timestamps
- **List Data Catalog Entries**: List every data structure and standard event available in the organization's data catalog
- **List Data Models**: List every dbt and SQL Runner data model with its schedule, owners, and next run time
- **List Data Product Data Models**: List the warehouse data model configurations attached to a data product
- **List Data Products**: List the organization's data products with their event specifications
- **List Data Product Subscriptions**: List who is subscribed to change notifications for a data product
- **List Data Product Templates**: List the prebuilt data product templates available to the organization
- **List Data Quality Alerts**: List the failed-event alerts and digests configured across the organization's pipelines
- **List Data Structure Deployments**: List every deployment of a data structure across environments and versions
- **List Data Structure Drafts**: List every draft data structure that has not yet been promoted to an environment
- **List Data Structure Draft Schemas**: Retrieve the JSON schema bodies of every draft data structure in one call
- **List Data Structures**: List the organization's data structures with their most recent deployment per environment
- **List Event Specifications**: List event specifications, optionally filtered by data product, source schema, or status
- **List Event Specification Versions**: List every version of one event specification
- **List Failed Event Metrics**: Get counts of failed events on a pipeline grouped by error, for a time range
- **List Job Runs**: List warehouse data model job runs starting inside a time range, with state and duration
- **List Job Run Steps**: List the steps of a warehouse job run with each step's state and dependencies
- **List Mini Enrichments**: List the enrichments configured on a Snowplow Mini instance and whether each is enabled
- **List Minis**: List the organization's Snowplow Mini test instances
- **List Organization Preferences**: List every organization preference with defaults applied for values that were never set
- **List Organizations**: List the organizations the access token grants access to, with tier, features, cloud, and deployment metadata
- **List Pipeline Enrichments**: List the enrichments configured on a pipeline and whether each is enabled
- **List Pipelines**: List the organization's pipelines with id, name, status, label, and collector endpoints
- **List Signals**: List the Signals configurations on the organization's pipelines and their status
- **List Slack Channels**: List the Slack channels available to receive data quality alerts
- **List Source Applications**: List the websites, apps, and services that send events into the organization's pipelines
- **List Users**: List every user in the organization with their capabilities and last login time
- **Patch Data Structure Metadata**: Update selected metadata fields on a data structure, leaving the rest unchanged
- **Patch Event Specification**: Update selected fields of an event specification without resubmitting the whole spec
- **Preview Data Product Data Model SQL**: Generate the SQL a data model configuration would produce without saving it
- **Promote Data Structure Draft**: Publish a draft data structure into the development environment
- **Replace Data Structure Metadata**: Fully replace a data structure's metadata including hidden flag, schema type, and custom data
- **Search Data Catalog**: Search the data catalog by name, vendor, or description and see which fields matched
- **Set Organization Preference**: Set the value of a single named organization preference
- **Share Data Product Instructions**: Email a data product's implementation instructions to a list of recipients
- **Sync Data Structures with Iglu**: Force a resync of the organization's data structures to the dev and prod Iglu schema servers
- **Update Collector Configuration**: Request an asynchronous change to a pipeline collector's domains, paths, and cookie attributes
- **Update Data Product**: Fully replace a data product's name, owner, domain, and source applications
- **Update Data Product Subscription**: Change the reason or notification policy on an existing data product subscription
- **Update Data Quality Alert**: Change the name, filters, destination, or subscribers on a data quality alert
- **Update Email Subscriptions**: Replace the per-pipeline email recipient lists for pipeline alerting and digest notifications
- **Update Event Specification**: Fully replace an event specification, creating a new version in its history
- **Update Signals Configuration**: Attach an existing or newly created destination target to a Signals configuration
- **Update Source Application**: Fully replace a source application's name, app ids, and default entities
- **Update User**: Replace a user's name, job title, and capability set
- **Validate Data Structure**: Validate a JSON schema and save it to the validated virtual environment ready for deployment

## Triggers (2)

- **Job Run Finished in Snowplow**: Triggers when a warehouse data model job run finishes (succeeded, failed, or skipped) in your Snowplow organization.
- **Job Run Failed in Snowplow**: Triggers only when a warehouse data model job run fails in your Snowplow organization.

Connect Snowplow in General Input: https://www.generalinput.com/apps/snowplow