Skip to main content
This guide will walk you through how to create a service token and set up the relevant configurations for your dbt Cloud projectWe need this information so we can connect to dbt and extract metadata such as runs and test failures. We only request read access to your metadata and won’t be able to read raw data or update or run any models.In order to be able to finish this guide you’ll need:
→ Access to dbt cloud
→ Having been assigned the owner role in dbt cloud⏱️ Estimated time to finish: 10 minutes.

​
Name your integration

For example dbt cloud

​
Set the API endpoint

Select the endpoint of the dbt Cloud region where your project is hosted:
  • cloud.getdbt.com (US)
  • emea.dbt.com (Europe)
  • au.dbt.com (Australia)
  • Custom endpoint, for an account with its own access URL, for example ACCOUNT_PREFIX.us1.dbt.com. Enter the host from the URL you use to open dbt Cloud.
You cannot change the endpoint after you create the integration. To use a different endpoint, create a new integration.

​
Generate a token

These steps will take you through how to create a token you can use to manage Coalesce Quality access to your dbt Cloud project
  1. Open dbt cloud and go to Account Settings in the menu bar
  • If you don’t see this option in the sidebar you don’t have the right dbt permission. If this is the case, either ask your dbt admin to make you an Owner (expand to see how) or ask the dbt admin to complete the steps in this guide
  1. Click Service Tokens
  1. Create New Token
  1. Name your token
This could be synq_token so you can identify it later
  1. Click Add to add a new permission
  2. Set permissions
  • Permission Set should be set to Read-Only. This will let Coalesce Quality read your dbt logs
  • Project should be set to your main dbt project. If you want to integrate multiple projects, add all projects you want to integrate or set to All Projects
  1. Save the token
  2. Copy the token value
Copy the token value now. dbt Cloud does not show it again.
If you use OAuth to connect dbt Cloud to Snowflake or Databricks, also enter the Snowflake account or Databricks workspace URL. The dbt Cloud API does not return it, and Coalesce Quality needs it to link models to their tables.

​
Select your dbt project

Choose your main dbt project

​
Select the job(s) you want Coalesce Quality to monitor

Select your production and source freshness jobs. Jobs that run dbt docs generate are recommended, as they produce catalog.json with column types and descriptions. In most cases, don’t monitor CI, staging or experimental jobs.

​
Connect Git (optional)

On the integration page, the Git section links the project to a Git integration, so that model changes link to commits. You can set a default branch, used for runs that don’t report their own branch (usually runs started through the dbt Cloud API). You can also override the project folder that dbt Cloud reports.

​
FAQ

​
What access do you require?

We only request read access to your metadata and won’t be able to read raw data or update or run any models

​
Will you store personal or business-critical data

Coalesce Quality only stores log level data and doesn’t access any actual data from your data warehouse

​
Which artifacts are you collecting from dbt

We are collecting the following artifacts from dbt. For more information about dbt artifacts see this article
  • manifest.json: to understand the structure of the warehouse
  • run_results.json: to see the status of executions
  • catalog.json: to be able to provide catalog-like functionality
  • Optionally sources.json: to capture dbt source freshness