Configuration

Prerequisites

In order to use this integration you need:

  • An account on dbt cloud

  • An api access on dbt cloud (please note that only paid plan have an API access)

  • A service token on the said account

  • A job that outputs a manifest.json & run-results.json

  • A job that outputs sources.json

Configure your service token on dbt Cloud

Go to your Account Settings > Service Token and create a new service token. Give this Service Token access to your desired project as well as the following roles:

  • Read Only

Once your service token is created, copy the key because you will not be able to access it again and save it for later.

Configure your project to output the proper artifacts

In order to get access to your manifest.json , run_results.json and source.json using the API, you should edit your Project Details and associate it with the 2 Jobs that are producing them.

  • Documentation Job: Associate it with a Job that output manifest.json & run_results.json

  • Source Freshness: Associate it with a Job that output source.json

The mapping between the CLI options and the produced outputs is available in dbt documentation.

Please reference the proper jobs at the project level:

Find your Account ID and Project ID

Open the job that you have configured at the previous step and extract the Account Id and Project Id from your URL.

The url should look like:

https://cloud.getdbt.com/next/deploy/<Account Id>/projects/<Project Id>/jobs

Configure Whaly

Open Whaly and go to the Settings. On the settings please click on Storage Admin > Models Sync. You should see a page like this:

Click on Activate dbt Cloud Sync for modeling.

You will then be prompted to enter your Service Token, your Account Id as well as your Project Id.

Once this is done, go into the Workbench and you'll see the dbt icon on the left bar.

Click on it to display the syncs panel. Click on a previous sync to checks its logs or click on the plus sign at the top of the page to trigger a sync between Whaly and dbt Cloud.

Last updated