Why connect to dbt Cloud?

Connecting Workstream to your dbt Cloud instance allows you to display a data status page alongside the asset. Workstream automatically registers a status page for any asset that is configured as an exposure in dbt Cloud.

Workstream also makes any data issues for your assets available in our environment trends page and notification. This gives you and your team near real-time monitoring into data quality and freshness, allowing you to more easily identify urgent issues with your assets.

How do I connect to dbt Cloud?

If possible, we recommend using a separate service account in dbt Cloud. This helps us avoid service interruptions, and makes the connection easier to manage. Follow our walkthrough to learn how to create a service account.

If you are just trying out Workstream, feel free to use your personal dbt Cloud account, as you can always switch over to a service account later. You will need an account that has Owner access in order to successfully generate an API token.

Step 1: Generating a Service Token

Service tokens allow secure system-to-system communication between dbt Cloud and Workstream. To generate this token, please take the following steps within dbt Cloud:

  1. Login as an owner

  2. Click on the menu icon in the top left corner and select "Account Settings"

  3. On the Account Settings screen, select "Service Tokens" from the left menu.

  4. Click the "New Token" button in the top right corner.

  5. Enter a name for the service token. We recommend including Workstream in the name, so the token is easily identifiable.

  6. After you enter a name, select the "+ Add" option under the Access section, so that you can add a new permission.

  7. Select "Account Admin" from the "Permission Sets" dropdown, and click "Save" in the top right corner of the screen.

  8. You will then be redirected to a screen showing the newly generated service token. This is the only time the service token is viewable, so save it in a secure location, or keep the page available in a separate browser tab when connecting your account to Workstream.

Step 2: Providing required information to Workstream

Your connections are created and managed under the "Settings" section, available by clicking on your workspace's name in the top left corner of the screen.

Find the dbt Cloud card and click "Connect".

The only required piece of information is your service token. Enter the service token you just created, and click "Connect" to create the connection.

Once you've connected, Workstream will begin importing information about your dbt Cloud sources, models, and exposures. Please allow a few minutes for this initial import to complete.

Did this answer your question?