Skip to main content

dbt Cloud - Trigger Job

info

This Blueprint is classified as "Free" and does not incur billable runtime. Learn more.

Overview​

Execute a single job on dbt Cloud, creating a new run. The job must be set up within the dbt Cloud interface. Platform does not support sending override commands to the job at this time.

This Blueprint will create and store the generated run ID to shipyard-artifacts/dbtcloud-blueprints/variables/run_id.pickle

The "cause" for an execution triggered via Platform will always contain the following details:

  • Fleet ID
  • Vessel ID
  • Vessel Log ID

The response for this request will always be stored at shipyard-artifacts/dbtcloud-blueprints/responses/job_JOBID_response.json

Variables​

NameReferenceTypeRequiredDefaultOptionsDescription
Service TokenDBT_API_KEYPassword✅--Your unique service token for dbt Cloud. Instructions for how to get this token can be found in the authorization documentation.
Account IDDBT_ACCOUNT_IDAlphanumeric✅--Your unique Account ID, found in the URL of dbt Cloud. https://cloud.getdbt.com/#/accounts/ACCOUNT_ID/projects/PROJECT_ID/dashboard/
Job IDDBT_JOB_IDAlphanumeric✅--The ID of a specific job you want to run, found in the URL of dbt Cloud. https://cloud.getdbt.com/#/accounts/ACCOUNT_ID/projects/PROJECT_ID/jobs/JOB_ID/
Wait For CompletionDBT_WAITBoolean✅TRUE-Enable if you want the vessel to wait until the sync job is successfully completed. Otherwise, the vessel will only initiate the sync job without waiting

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
  blueprint: dbt Cloud - Trigger Job
  inputs:
    DBT_API_KEY: null  ## REQUIRED
    DBT_ACCOUNT_ID: null ## REQUIRED
    DBT_JOB_ID: null ## REQUIRED
    DBT_WAIT: 'TRUE' ## REQUIRED
  type: BLUEPRINT
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - '200'
    - '201'
    - '211'
    - '212'