dbt Cloud
App · 25 actions
Run and watch your dbt Cloud jobs: start a run and wait for it, rerun failures, read run logs and artifacts, create and change jobs, and start workflows when a run finishes or fails.
Actions
| Action | What it does |
|---|---|
| Cancel run | Cancel a run that is queued or running. |
| Create job | Create a deploy job in an environment that runs your dbt commands, on a schedule or only when started. |
| Delete job | Delete a job. |
| Get account | Get the connected dbt account: its name, plan and how many runs it can run at once. |
| Get environment | Get one environment: its kind, dbt version, custom branch and the connection and credentials it uses. |
| Get job | Get one job: its commands, schedule, settings and environment. |
| Get latest job artifact | Get a file from a job's most recent run, such as its manifest.json, without knowing the run's id. |
| Get project | Get one dbt project with its warehouse connection and git repository. |
| Get run | Get a run's status, times, branch and each step with its logs. |
| Get run artifact | Get a file a run saved, such as run_results.json with each model's result and timing. |
| Get run step | Get one step of a run, such as dbt build, with its status, timing and logs. |
| List connections | List the account's data warehouse connections, such as Snowflake or BigQuery, and how many environments use each. |
| List environments | List a project's environments: the deployment environments jobs run in and the development environment of the IDE. |
| List jobs | List the account's jobs by name, with their commands, schedule and environment. |
| List projects | List the account's dbt projects by name, with their warehouse connection and repository ids. |
| List repositories | List the git repositories the account's projects are connected to. |
| List run artifacts | List the files a run saved, such as manifest.json and run_results.json. |
| List runs | List runs, newest first, for a job, project or environment, and by status, such as every failed run. |
| List users | List the people in the account with their emails, by name or licence. |
| List webhooks | List the account's webhooks: where each sends run events, which events, and whether its last delivery worked. |
| Rerun job from failure | Rerun a job's most recent failed run from the step that failed, skipping what already succeeded. |
| Retry run | Rerun a failed run from the step that failed, as a new run. |
| Run job | Start a run of a job, optionally on another branch or with other commands. |
| Update job | Change a job's name, commands, schedule or settings. |
| Wait for run to finish | Wait until a run has succeeded, failed or been cancelled, then return it. |
Cancel run
Cancel a run that is queued or running.
Inputs
- Run ID
run_idtextRequired - The run's id, from 'Run job', 'List runs' or a trigger.
Outputs
runobject- The run
Example output
{
"run": {
"account_id": 12345,
"artifacts_saved": true,
"can_retry": false,
"created_at": "2026-10-20 06:00:01.000000+00:00",
"dbt_version": "latest",
"dequeued_at": "2026-10-20 06:00:09.000000+00:00",
"duration": "00:03:03",
"duration_humanized": "3 minutes, 3 seconds",
"environment_id": 218762,
"finished_at": "2026-10-20 06:03:04.000000+00:00",
"git_branch": "main",
"git_sha": "8d1f2a7c",
"has_docs_generated": true,
"href": "https://cloud.getdbt.com/deploy/12345/projects/270542/runs/70403103/",
"id": 70403103,
"in_progress": false,
"is_cancelled": true,
"is_complete": true,
"is_error": false,
"is_success": false,
"job": {
"id": 567183,
"name": "Daily build",
"project_id": 270542
},
"job_definition_id": 567183,
"job_id": 567183,
"project_id": 270542,
"retrying_run_id": 0,
"run_duration_humanized": "2 minutes, 44 seconds",
"run_steps": [
{
"account_id": 12345,
"debug_logs": "",
"duration": "00:02:41",
"duration_humanized": "2 minutes, 41 seconds",
"finished_at": "2026-10-20 06:03:02.000000+00:00",
"id": 412000001,
"index": 1,
"logs": "Completed successfully\nDone. PASS=42 WARN=0 ERROR=0 SKIP=0 TOTAL=42",
"name": "Invoke dbt with `dbt build`",
"run_id": 70403103,
"started_at": "2026-10-20 06:00:21.000000+00:00",
"status": 10,
"status_humanized": "Success",
"truncated_debug_logs": ""
}
],
"started_at": "2026-10-20 06:00:20.000000+00:00",
"status": 30,
"status_humanized": "Cancelled",
"status_message": "",
"trigger": {
"cause": "Started by a Lodol workflow",
"cause_category": "api",
"git_branch": "",
"git_sha": "",
"job_definition_id": 567183,
"schema_override": "",
"steps_override": []
},
"trigger_id": 71000001,
"updated_at": "2026-10-20 06:03:05.000000+00:00"
}
}Create job
Create a deploy job in an environment that runs your dbt commands, on a schedule or only when started.
Inputs
- Project
project_idtextRequired - The dbt project. Pick one, or give its id from an earlier step.
- Environment
environment_idtextRequired - The environment. Pick one, or give its id from an earlier step.
- Name
nametextRequired - The job's name.
- Commands
commandslistRequired - The dbt commands to run, one per line, such as dbt build or dbt run --select my_model.
- Description
descriptiontext - What the job is for.
- Schedule (cron)
crontext - When to run it, as a cron schedule in UTC, such as 0 6 * * * for every day at 06:00. Leave empty to run it only when started.
- Generate docs
generate_docstrue/false - Also run dbt docs generate at the end of each run.
- Threads
threadsnumber - How many models dbt builds at once, 1 to 64. Defaults to 4.From 1 to 64.
- Target name
target_nametext - The value of target.name in your dbt code. Defaults to default.
- Timeout (seconds)
timeout_secondsnumber - Stop a run that takes longer than this. 0 means no limit.At least 0.
Outputs
jobobject- The job
Example output
{
"job": {
"account_id": 12345,
"created_at": "2025-03-01T09:00:00.000000+00:00",
"dbt_version": "",
"deferring_environment_id": 0,
"deferring_job_definition_id": 0,
"description": "Builds and tests every model.",
"environment_id": 218762,
"execute_steps": [
"dbt build"
],
"execution": {
"timeout_seconds": 0
},
"generate_docs": true,
"id": 567183,
"job_type": "scheduled",
"name": "Daily build",
"project_id": 270542,
"run_generate_sources": false,
"schedule": {
"cron": "0 6 * * *",
"date": {
"cron": "0 6 * * *",
"type": "custom_cron"
},
"time": {
"interval": 1,
"type": "every_hour"
}
},
"settings": {
"target_name": "default",
"threads": 4
},
"state": 1,
"triggers": {
"git_provider_webhook": false,
"github_webhook": false,
"on_merge": false,
"schedule": true
},
"updated_at": "2026-10-01T09:00:00.000000+00:00"
}
}Delete job
Delete a job. Its past runs stay in the run history.
Inputs
- Job
job_idtextRequired - The dbt job. Pick one, or give its id from an earlier step.
Outputs
deletedtrue/false- Always true once deleted
job_idnumber- The job deleted
Example output
{
"deleted": true,
"job_id": 567183
}Get account
Get the connected dbt account: its name, plan and how many runs it can run at once.
Inputs
None.
Outputs
accountobject- The account
Example output
{
"account": {
"created_at": "2025-03-01T09:00:00.000000+00:00",
"developer_seats": 8,
"id": 12345,
"identifier": "act_2abcDEF",
"locked": false,
"name": "Acme Analytics",
"plan": "starter",
"read_only_seats": 50,
"run_slots": 5,
"state": 1,
"updated_at": "2026-10-01T09:00:00.000000+00:00"
}
}Get environment
Get one environment: its kind, dbt version, custom branch and the connection and credentials it uses.
Inputs
- Environment
environment_idtextRequired - The environment. Pick one, or give its id from an earlier step.
Outputs
environmentobject- The environment
Example output
{
"environment": {
"account_id": 12345,
"connection_id": 31000,
"created_at": "2025-03-01T09:00:00.000000+00:00",
"credentials_id": 51000,
"custom_branch": "",
"dbt_version": "latest",
"deployment_type": "production",
"id": 218762,
"name": "Production",
"project_id": 270542,
"repository_id": 41000,
"state": 1,
"type": "deployment",
"updated_at": "2026-10-01T09:00:00.000000+00:00",
"use_custom_branch": false
}
}Get job
Get one job: its commands, schedule, settings and environment.
Inputs
- Job
job_idtextRequired - The dbt job. Pick one, or give its id from an earlier step.
Outputs
jobobject- The job
Example output
{
"job": {
"account_id": 12345,
"created_at": "2025-03-01T09:00:00.000000+00:00",
"dbt_version": "",
"deferring_environment_id": 0,
"deferring_job_definition_id": 0,
"description": "Builds and tests every model.",
"environment_id": 218762,
"execute_steps": [
"dbt build"
],
"execution": {
"timeout_seconds": 0
},
"generate_docs": true,
"id": 567183,
"job_type": "scheduled",
"name": "Daily build",
"project_id": 270542,
"run_generate_sources": false,
"schedule": {
"cron": "0 6 * * *",
"date": {
"cron": "0 6 * * *",
"type": "custom_cron"
},
"time": {
"interval": 1,
"type": "every_hour"
}
},
"settings": {
"target_name": "default",
"threads": 4
},
"state": 1,
"triggers": {
"git_provider_webhook": false,
"github_webhook": false,
"on_merge": false,
"schedule": true
},
"updated_at": "2026-10-01T09:00:00.000000+00:00"
}
}Get latest job artifact
Get a file from a job's most recent run, such as its manifest.json, without knowing the run's id.
Inputs
- Job
job_idtextRequired - The dbt job. Pick one, or give its id from an earlier step.
- Artifact
artifact_pathtextRequired - The file in the run's target folder, such as manifest.json, run_results.json, catalog.json or sources.json.
Outputs
contentobject- The file's contents: data for a JSON file, text otherwise
is_jsontrue/false- Whether the file was JSON, read into 'content' as data
pathtext- The artifact's path
size_bytesnumber- The file's size in bytes
Example output
{
"content": {
"metadata": {
"dbt_version": "1.10.0",
"project_name": "analytics"
},
"nodes": {
"model.analytics.orders": {
"name": "orders"
}
}
},
"is_json": true,
"path": "manifest.json",
"size_bytes": 4823011
}Get project
Get one dbt project with its warehouse connection and git repository.
Inputs
- Project
project_idtextRequired - The dbt project. Pick one, or give its id from an earlier step.
Outputs
projectobject- The project
Example output
{
"project": {
"account_id": 12345,
"connection": {
"id": 31000,
"name": "Snowflake",
"type": "snowflake"
},
"connection_id": 31000,
"created_at": "2025-03-01T09:00:00.000000+00:00",
"dbt_project_subdirectory": "",
"description": "The company's dbt project.",
"id": 270542,
"name": "Analytics",
"repository": {
"full_name": "acme/analytics",
"id": 41000
},
"repository_id": 41000,
"state": 1,
"updated_at": "2026-10-01T09:00:00.000000+00:00"
}
}Get run
Get a run's status, times, branch and each step with its logs.
Inputs
- Run ID
run_idtextRequired - The run's id, from 'Run job', 'List runs' or a trigger.
- Include debug logs
include_debug_logstrue/false - Also return the full debug logs. Without this dbt returns the last 1,000 lines of them.
Outputs
runobject- The run
Example output
{
"run": {
"account_id": 12345,
"artifacts_saved": true,
"can_retry": false,
"created_at": "2026-10-20 06:00:01.000000+00:00",
"dbt_version": "latest",
"dequeued_at": "2026-10-20 06:00:09.000000+00:00",
"duration": "00:03:03",
"duration_humanized": "3 minutes, 3 seconds",
"environment_id": 218762,
"finished_at": "2026-10-20 06:03:04.000000+00:00",
"git_branch": "main",
"git_sha": "8d1f2a7c",
"has_docs_generated": true,
"href": "https://cloud.getdbt.com/deploy/12345/projects/270542/runs/70403103/",
"id": 70403103,
"in_progress": false,
"is_cancelled": false,
"is_complete": true,
"is_error": false,
"is_success": true,
"job": {
"id": 567183,
"name": "Daily build",
"project_id": 270542
},
"job_definition_id": 567183,
"job_id": 567183,
"project_id": 270542,
"retrying_run_id": 0,
"run_duration_humanized": "2 minutes, 44 seconds",
"run_steps": [
{
"account_id": 12345,
"debug_logs": "",
"duration": "00:02:41",
"duration_humanized": "2 minutes, 41 seconds",
"finished_at": "2026-10-20 06:03:02.000000+00:00",
"id": 412000001,
"index": 1,
"logs": "Completed successfully\nDone. PASS=42 WARN=0 ERROR=0 SKIP=0 TOTAL=42",
"name": "Invoke dbt with `dbt build`",
"run_id": 70403103,
"started_at": "2026-10-20 06:00:21.000000+00:00",
"status": 10,
"status_humanized": "Success",
"truncated_debug_logs": ""
}
],
"started_at": "2026-10-20 06:00:20.000000+00:00",
"status": 10,
"status_humanized": "Success",
"status_message": "",
"trigger": {
"cause": "Started by a Lodol workflow",
"cause_category": "api",
"git_branch": "",
"git_sha": "",
"job_definition_id": 567183,
"schema_override": "",
"steps_override": []
},
"trigger_id": 71000001,
"updated_at": "2026-10-20 06:03:05.000000+00:00"
}
}Get run artifact
Get a file a run saved, such as run_results.json with each model's result and timing. A JSON file comes back as data.
Inputs
- Run ID
run_idtextRequired - The run's id, from 'Run job', 'List runs' or a trigger.
- Artifact
artifact_pathtextRequired - The file in the run's target folder, such as manifest.json, run_results.json, catalog.json or sources.json.
- Step number
stepnumber - Which step of the run, counting from 1. Leave empty for the last step.At least 1.
Outputs
contentobject- The file's contents: data for a JSON file, text otherwise
is_jsontrue/false- Whether the file was JSON, read into 'content' as data
pathtext- The artifact's path
size_bytesnumber- The file's size in bytes
Example output
{
"content": {
"elapsed_time": 161.3,
"metadata": {
"dbt_version": "1.10.0"
},
"results": [
{
"execution_time": 4.2,
"status": "success",
"unique_id": "model.analytics.orders"
}
]
},
"is_json": true,
"path": "run_results.json",
"size_bytes": 18234
}Get run step
Get one step of a run, such as dbt build, with its status, timing and logs. Step ids are in a run's run_steps.
Inputs
- Step ID
step_idtextRequired - The step's id, from the run_steps of 'Get run'.
- Include debug logs
include_debug_logstrue/false - Also return the full debug logs. Without this dbt returns the last 1,000 lines of them.
Outputs
stepobject- The run step
Example output
{
"step": {
"account_id": 12345,
"debug_logs": "",
"duration": "00:02:41",
"duration_humanized": "2 minutes, 41 seconds",
"finished_at": "2026-10-20 06:03:02.000000+00:00",
"id": 412000001,
"index": 1,
"logs": "Completed successfully\nDone. PASS=42 WARN=0 ERROR=0 SKIP=0 TOTAL=42",
"name": "Invoke dbt with `dbt build`",
"run_id": 70403103,
"started_at": "2026-10-20 06:00:21.000000+00:00",
"status": 10,
"status_humanized": "Success",
"truncated_debug_logs": ""
}
}List connections
List the account's data warehouse connections, such as Snowflake or BigQuery, and how many environments use each.
Inputs
- Name contains
searchtext - Only those whose name contains this text.
- Page size
limitnumber - How many to return, 1 to 100. Defaults to 100.From 1 to 100.
- Skip
offsetnumber - How many to skip, for the next page: the 'next_offset' of an earlier page.At least 0.
Outputs
connectionslist- The connections
countnumber- How many are on this page
has_moretrue/false- Whether there are more after this page
next_offsetnumber- The 'Skip' to give for the next page, 0 when there is none
total_countnumber- How many there are in all
Example output
{
"connections": [
{
"account_id": 12345,
"adapter_version": "snowflake_v0",
"created_at": "2025-03-01T09:00:00.000000+00:00",
"environment__count": 2,
"id": 31000,
"is_ssh_tunnel_enabled": false,
"name": "Snowflake",
"updated_at": "2026-10-01T09:00:00.000000+00:00"
}
],
"count": 1,
"has_more": false,
"next_offset": 0,
"total_count": 1
}List environments
List a project's environments: the deployment environments jobs run in and the development environment of the IDE.
Inputs
- Project
project_idtextRequired - The dbt project. Pick one, or give its id from an earlier step.
- Kind
environment_typetext - Only deployment or only development environments.One of:
deployment(Deployment (runs jobs)),development(Development (the IDE)). - Deployment type
deployment_typetext - Only production or only staging environments.One of:
production,staging. - Page size
limitnumber - How many to return, 1 to 100. Defaults to 100.From 1 to 100.
- Skip
offsetnumber - How many to skip, for the next page: the 'next_offset' of an earlier page.At least 0.
Outputs
countnumber- How many are on this page
environmentslist- The environments
has_moretrue/false- Whether there are more after this page
next_offsetnumber- The 'Skip' to give for the next page, 0 when there is none
total_countnumber- How many there are in all
Example output
{
"count": 1,
"environments": [
{
"account_id": 12345,
"connection_id": 31000,
"created_at": "2025-03-01T09:00:00.000000+00:00",
"credentials_id": 51000,
"custom_branch": "",
"dbt_version": "latest",
"deployment_type": "production",
"id": 218762,
"name": "Production",
"project_id": 270542,
"repository_id": 41000,
"state": 1,
"type": "deployment",
"updated_at": "2026-10-01T09:00:00.000000+00:00",
"use_custom_branch": false
}
],
"has_more": false,
"next_offset": 0,
"total_count": 1
}List jobs
List the account's jobs by name, with their commands, schedule and environment.
Inputs
- Project
project_idtext - Only those in this project. Leave empty for every project.
- Environment
environment_idtext - Only those in this environment. Leave empty for every environment.
- Name contains
searchtext - Only those whose name contains this text.
- Page size
limitnumber - How many to return, 1 to 100. Defaults to 100.From 1 to 100.
- Skip
offsetnumber - How many to skip, for the next page: the 'next_offset' of an earlier page.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether there are more after this page
jobslist- The jobs
next_offsetnumber- The 'Skip' to give for the next page, 0 when there is none
total_countnumber- How many there are in all
Example output
{
"count": 1,
"has_more": false,
"jobs": [
{
"account_id": 12345,
"created_at": "2025-03-01T09:00:00.000000+00:00",
"dbt_version": "",
"deferring_environment_id": 0,
"deferring_job_definition_id": 0,
"description": "Builds and tests every model.",
"environment_id": 218762,
"execute_steps": [
"dbt build"
],
"execution": {
"timeout_seconds": 0
},
"generate_docs": true,
"id": 567183,
"job_type": "scheduled",
"name": "Daily build",
"project_id": 270542,
"run_generate_sources": false,
"schedule": {
"cron": "0 6 * * *",
"date": {
"cron": "0 6 * * *",
"type": "custom_cron"
},
"time": {
"interval": 1,
"type": "every_hour"
}
},
"settings": {
"target_name": "default",
"threads": 4
},
"state": 1,
"triggers": {
"git_provider_webhook": false,
"github_webhook": false,
"on_merge": false,
"schedule": true
},
"updated_at": "2026-10-01T09:00:00.000000+00:00"
}
],
"next_offset": 0,
"total_count": 1
}List projects
List the account's dbt projects by name, with their warehouse connection and repository ids.
Inputs
- Name contains
searchtext - Only those whose name contains this text.
- Page size
limitnumber - How many to return, 1 to 100. Defaults to 100.From 1 to 100.
- Skip
offsetnumber - How many to skip, for the next page: the 'next_offset' of an earlier page.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether there are more after this page
next_offsetnumber- The 'Skip' to give for the next page, 0 when there is none
projectslist- The projects
total_countnumber- How many there are in all
Example output
{
"count": 1,
"has_more": false,
"next_offset": 0,
"projects": [
{
"account_id": 12345,
"connection": {
"id": 31000,
"name": "Snowflake",
"type": "snowflake"
},
"connection_id": 31000,
"created_at": "2025-03-01T09:00:00.000000+00:00",
"dbt_project_subdirectory": "",
"description": "The company's dbt project.",
"id": 270542,
"name": "Analytics",
"repository": {
"full_name": "acme/analytics",
"id": 41000
},
"repository_id": 41000,
"state": 1,
"updated_at": "2026-10-01T09:00:00.000000+00:00"
}
],
"total_count": 1
}List repositories
List the git repositories the account's projects are connected to.
Inputs
- Project
project_idtext - Only those in this project. Leave empty for every project.
- Page size
limitnumber - How many to return, 1 to 100. Defaults to 100.From 1 to 100.
- Skip
offsetnumber - How many to skip, for the next page: the 'next_offset' of an earlier page.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether there are more after this page
next_offsetnumber- The 'Skip' to give for the next page, 0 when there is none
repositorieslist- The repositories
total_countnumber- How many there are in all
Example output
{
"count": 1,
"has_more": false,
"next_offset": 0,
"repositories": [
{
"account_id": 12345,
"created_at": "2025-03-01T09:00:00.000000+00:00",
"full_name": "acme/analytics",
"git_clone_strategy": "github_app",
"id": 41000,
"project_id": 270542,
"remote_backend": "github",
"remote_url": "git@github.com:acme/analytics.git",
"state": 1,
"updated_at": "2026-10-01T09:00:00.000000+00:00"
}
],
"total_count": 1
}List run artifacts
List the files a run saved, such as manifest.json and run_results.json.
Inputs
- Run ID
run_idtextRequired - The run's id, from 'Run job', 'List runs' or a trigger.
- Step number
stepnumber - Which step of the run, counting from 1. Leave empty for the last step.At least 1.
Outputs
artifactslist- The file paths, such as manifest.json
countnumber- How many there are
Example output
{
"artifacts": [
"manifest.json",
"run_results.json",
"catalog.json"
],
"count": 3
}List runs
List runs, newest first, for a job, project or environment, and by status, such as every failed run.
Inputs
- Job
job_idtext - Only runs of this job. Leave empty for every job.
- Project
project_idtext - Only those in this project. Leave empty for every project.
- Environment
environment_idtext - Only those in this environment. Leave empty for every environment.
- Status
statuseslist - Only runs in these states. Leave empty for all.One or more of:
queued,starting,running,success(Succeeded),error(Failed (error)),cancelled. - Order
order_bytext - Which runs come first. Defaults to newest first.One of:
-id(Newest first (default)),id(Oldest first),-finished_at(Most recently finished first). Default:-id. - Page size
limitnumber - How many to return, 1 to 100. Defaults to 100.From 1 to 100.
- Skip
offsetnumber - How many to skip, for the next page: the 'next_offset' of an earlier page.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether there are more after this page
next_offsetnumber- The 'Skip' to give for the next page, 0 when there is none
runslist- The runs
total_countnumber- How many there are in all
Example output
{
"count": 1,
"has_more": false,
"next_offset": 0,
"runs": [
{
"account_id": 12345,
"artifacts_saved": true,
"can_retry": false,
"created_at": "2026-10-20 06:00:01.000000+00:00",
"dbt_version": "latest",
"dequeued_at": "2026-10-20 06:00:09.000000+00:00",
"duration": "00:03:03",
"duration_humanized": "3 minutes, 3 seconds",
"environment_id": 218762,
"finished_at": "2026-10-20 06:03:04.000000+00:00",
"git_branch": "main",
"git_sha": "8d1f2a7c",
"has_docs_generated": true,
"href": "https://cloud.getdbt.com/deploy/12345/projects/270542/runs/70403103/",
"id": 70403103,
"in_progress": false,
"is_cancelled": false,
"is_complete": true,
"is_error": false,
"is_success": true,
"job": {
"id": 567183,
"name": "Daily build",
"project_id": 270542
},
"job_definition_id": 567183,
"job_id": 567183,
"project_id": 270542,
"retrying_run_id": 0,
"run_duration_humanized": "2 minutes, 44 seconds",
"run_steps": [
{
"account_id": 12345,
"debug_logs": "",
"duration": "00:02:41",
"duration_humanized": "2 minutes, 41 seconds",
"finished_at": "2026-10-20 06:03:02.000000+00:00",
"id": 412000001,
"index": 1,
"logs": "Completed successfully\nDone. PASS=42 WARN=0 ERROR=0 SKIP=0 TOTAL=42",
"name": "Invoke dbt with `dbt build`",
"run_id": 70403103,
"started_at": "2026-10-20 06:00:21.000000+00:00",
"status": 10,
"status_humanized": "Success",
"truncated_debug_logs": ""
}
],
"started_at": "2026-10-20 06:00:20.000000+00:00",
"status": 10,
"status_humanized": "Success",
"status_message": "",
"trigger": {
"cause": "Started by a Lodol workflow",
"cause_category": "api",
"git_branch": "",
"git_sha": "",
"job_definition_id": 567183,
"schema_override": "",
"steps_override": []
},
"trigger_id": 71000001,
"updated_at": "2026-10-20 06:03:05.000000+00:00"
}
],
"total_count": 1
}List users
List the people in the account with their emails, by name or licence.
Inputs
- Search
searchtext - Only people whose name or email contains this text.
- Licence
license_typetext - Only people with this licence.One of:
developer,analyst,read_only(Read-only),it. - Page size
limitnumber - How many to return, 1 to 100. Defaults to 100.From 1 to 100.
- Skip
offsetnumber - How many to skip, for the next page: the 'next_offset' of an earlier page.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether there are more after this page
next_offsetnumber- The 'Skip' to give for the next page, 0 when there is none
total_countnumber- How many there are in all
userslist- The users
Example output
{
"count": 1,
"has_more": false,
"next_offset": 0,
"total_count": 1,
"users": [
{
"created_at": "2025-03-01T09:00:00.000000+00:00",
"email": "jo@example.com",
"first_name": "Jo",
"id": 9001,
"is_active": true,
"last_login": "2026-10-19T15:04:00.000000+00:00",
"last_name": "Bloggs"
}
]
}List webhooks
List the account's webhooks: where each sends run events, which events, and whether its last delivery worked.
Inputs
- Page size
limitnumber - How many to return, 1 to 100. Defaults to 100.From 1 to 100.
- Skip
offsetnumber - How many to skip, for the next page: the 'next_offset' of an earlier page.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether there are more after this page
next_offsetnumber- The 'Skip' to give for the next page, 0 when there is none
total_countnumber- How many there are in all
webhookslist- The webhooks
Example output
{
"count": 1,
"has_more": false,
"next_offset": 0,
"total_count": 1,
"webhooks": [
{
"account_id": 12345,
"active": true,
"client_url": "https://example.com/dbt-hooks",
"deactivate_reason": "",
"description": "Posts failed runs to the on-call channel.",
"dispatched_at": "2026-10-20T06:03:06.000000Z",
"event_types": [
"job.run.errored"
],
"http_status_code": "200",
"id": "wsu_12345abcde",
"job_ids": [
"567183"
],
"name": "Alert on failures"
}
]
}Rerun job from failure
Rerun a job's most recent failed run from the step that failed, skipping what already succeeded.
Inputs
- Job
job_idtextRequired - The dbt job. Pick one, or give its id from an earlier step.
Outputs
runobject- The run
Example output
{
"run": {
"account_id": 12345,
"artifacts_saved": true,
"can_retry": false,
"created_at": "2026-10-20 06:00:01.000000+00:00",
"dbt_version": "latest",
"dequeued_at": "2026-10-20 06:00:09.000000+00:00",
"duration": "00:03:03",
"duration_humanized": "3 minutes, 3 seconds",
"environment_id": 218762,
"finished_at": "2026-10-20 06:03:04.000000+00:00",
"git_branch": "main",
"git_sha": "8d1f2a7c",
"has_docs_generated": true,
"href": "https://cloud.getdbt.com/deploy/12345/projects/270542/runs/70403103/",
"id": 70403103,
"in_progress": false,
"is_cancelled": false,
"is_complete": true,
"is_error": false,
"is_success": true,
"job": {
"id": 567183,
"name": "Daily build",
"project_id": 270542
},
"job_definition_id": 567183,
"job_id": 567183,
"project_id": 270542,
"retrying_run_id": 0,
"run_duration_humanized": "2 minutes, 44 seconds",
"run_steps": [
{
"account_id": 12345,
"debug_logs": "",
"duration": "00:02:41",
"duration_humanized": "2 minutes, 41 seconds",
"finished_at": "2026-10-20 06:03:02.000000+00:00",
"id": 412000001,
"index": 1,
"logs": "Completed successfully\nDone. PASS=42 WARN=0 ERROR=0 SKIP=0 TOTAL=42",
"name": "Invoke dbt with `dbt build`",
"run_id": 70403103,
"started_at": "2026-10-20 06:00:21.000000+00:00",
"status": 10,
"status_humanized": "Success",
"truncated_debug_logs": ""
}
],
"started_at": "2026-10-20 06:00:20.000000+00:00",
"status": 10,
"status_humanized": "Success",
"status_message": "",
"trigger": {
"cause": "Started by a Lodol workflow",
"cause_category": "api",
"git_branch": "",
"git_sha": "",
"job_definition_id": 567183,
"schema_override": "",
"steps_override": []
},
"trigger_id": 71000001,
"updated_at": "2026-10-20 06:03:05.000000+00:00"
}
}Retry run
Rerun a failed run from the step that failed, as a new run.
Inputs
- Run ID
run_idtextRequired - The run's id, from 'Run job', 'List runs' or a trigger.
Outputs
runobject- The run
Example output
{
"run": {
"account_id": 12345,
"artifacts_saved": true,
"can_retry": false,
"created_at": "2026-10-20 06:00:01.000000+00:00",
"dbt_version": "latest",
"dequeued_at": "2026-10-20 06:00:09.000000+00:00",
"duration": "00:03:03",
"duration_humanized": "3 minutes, 3 seconds",
"environment_id": 218762,
"finished_at": "2026-10-20 06:03:04.000000+00:00",
"git_branch": "main",
"git_sha": "8d1f2a7c",
"has_docs_generated": true,
"href": "https://cloud.getdbt.com/deploy/12345/projects/270542/runs/70403103/",
"id": 70403103,
"in_progress": false,
"is_cancelled": false,
"is_complete": true,
"is_error": false,
"is_success": true,
"job": {
"id": 567183,
"name": "Daily build",
"project_id": 270542
},
"job_definition_id": 567183,
"job_id": 567183,
"project_id": 270542,
"retrying_run_id": 0,
"run_duration_humanized": "2 minutes, 44 seconds",
"run_steps": [
{
"account_id": 12345,
"debug_logs": "",
"duration": "00:02:41",
"duration_humanized": "2 minutes, 41 seconds",
"finished_at": "2026-10-20 06:03:02.000000+00:00",
"id": 412000001,
"index": 1,
"logs": "Completed successfully\nDone. PASS=42 WARN=0 ERROR=0 SKIP=0 TOTAL=42",
"name": "Invoke dbt with `dbt build`",
"run_id": 70403103,
"started_at": "2026-10-20 06:00:21.000000+00:00",
"status": 10,
"status_humanized": "Success",
"truncated_debug_logs": ""
}
],
"started_at": "2026-10-20 06:00:20.000000+00:00",
"status": 10,
"status_humanized": "Success",
"status_message": "",
"trigger": {
"cause": "Started by a Lodol workflow",
"cause_category": "api",
"git_branch": "",
"git_sha": "",
"job_definition_id": 567183,
"schema_override": "",
"steps_override": []
},
"trigger_id": 71000001,
"updated_at": "2026-10-20 06:03:05.000000+00:00"
}
}Run job
Start a run of a job, optionally on another branch or with other commands. It returns once the run is queued; use 'Wait for run to finish' to wait for it.
Inputs
- Job
job_idtextRequired - The dbt job. Pick one, or give its id from an earlier step.
- Reason
causetext - Why it's running, shown in dbt's run history. Defaults to 'Started by a Lodol workflow'.
- Git branch
git_branchtext - Run the code on this branch instead of the environment's.
- Git commit
git_shatext - Run the code at this commit SHA instead.
- Schema
schema_overridetext - Build into this schema instead of the target's.
- Target name
target_name_overridetext - Use this value of target.name for this run.
- Threads
threads_overridenumber - Build this many models at once for this run, 1 to 64.From 1 to 64.
- Timeout (seconds)
timeout_seconds_overridenumber - Stop this run if it takes longer. 0 means no limit.At least 0.
- Generate docs
generate_docs_overridetext - Generate docs on this run, or not, whatever the job says.One of:
true(Yes),false(No). - Commands
steps_overridelist - Run these dbt commands instead of the job's, one per line.
Outputs
runobject- The run
Example output
{
"run": {
"account_id": 12345,
"artifacts_saved": true,
"can_retry": false,
"created_at": "2026-10-20 06:00:01.000000+00:00",
"dbt_version": "latest",
"dequeued_at": "2026-10-20 06:00:09.000000+00:00",
"duration": "00:03:03",
"duration_humanized": "3 minutes, 3 seconds",
"environment_id": 218762,
"finished_at": "2026-10-20 06:03:04.000000+00:00",
"git_branch": "main",
"git_sha": "8d1f2a7c",
"has_docs_generated": true,
"href": "https://cloud.getdbt.com/deploy/12345/projects/270542/runs/70403103/",
"id": 70403103,
"in_progress": false,
"is_cancelled": false,
"is_complete": true,
"is_error": false,
"is_success": true,
"job": {
"id": 567183,
"name": "Daily build",
"project_id": 270542
},
"job_definition_id": 567183,
"job_id": 567183,
"project_id": 270542,
"retrying_run_id": 0,
"run_duration_humanized": "2 minutes, 44 seconds",
"run_steps": [
{
"account_id": 12345,
"debug_logs": "",
"duration": "00:02:41",
"duration_humanized": "2 minutes, 41 seconds",
"finished_at": "2026-10-20 06:03:02.000000+00:00",
"id": 412000001,
"index": 1,
"logs": "Completed successfully\nDone. PASS=42 WARN=0 ERROR=0 SKIP=0 TOTAL=42",
"name": "Invoke dbt with `dbt build`",
"run_id": 70403103,
"started_at": "2026-10-20 06:00:21.000000+00:00",
"status": 10,
"status_humanized": "Success",
"truncated_debug_logs": ""
}
],
"started_at": "2026-10-20 06:00:20.000000+00:00",
"status": 10,
"status_humanized": "Success",
"status_message": "",
"trigger": {
"cause": "Started by a Lodol workflow",
"cause_category": "api",
"git_branch": "",
"git_sha": "",
"job_definition_id": 567183,
"schema_override": "",
"steps_override": []
},
"trigger_id": 71000001,
"updated_at": "2026-10-20 06:03:05.000000+00:00"
}
}Update job
Change a job's name, commands, schedule or settings. Only the fields you fill in change.
Inputs
- Job
job_idtextRequired - The dbt job. Pick one, or give its id from an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Description
descriptiontext - A new description. Leave empty to keep it.
- Commands
commandslist - The dbt commands to run, one per line, such as dbt build or dbt run --select my_model. Leave empty to keep them.
- Environment
environment_idtext - Move the job to this environment. Leave empty to keep it.
- Schedule (cron)
crontext - A new cron schedule in UTC, such as 0 6 * * *. It turns the schedule on. Leave empty to keep it.
- Schedule on or off
scheduletext - Turn the job's schedule on or off. Leave empty to keep it as is.One of:
on,off. - Generate docs
generate_docstext - Whether each run also generates docs. Leave empty to keep it.One of:
true(Yes),false(No). - Threads
threadsnumber - How many models dbt builds at once, 1 to 64.From 1 to 64.
- Target name
target_nametext - A new value for target.name. Leave empty to keep it.
- Timeout (seconds)
timeout_secondsnumber - Stop a run that takes longer than this. 0 means no limit.At least 0.
Outputs
jobobject- The job
Example output
{
"job": {
"account_id": 12345,
"created_at": "2025-03-01T09:00:00.000000+00:00",
"dbt_version": "",
"deferring_environment_id": 0,
"deferring_job_definition_id": 0,
"description": "Builds and tests every model.",
"environment_id": 218762,
"execute_steps": [
"dbt build"
],
"execution": {
"timeout_seconds": 0
},
"generate_docs": true,
"id": 567183,
"job_type": "scheduled",
"name": "Daily build",
"project_id": 270542,
"run_generate_sources": false,
"schedule": {
"cron": "0 6 * * *",
"date": {
"cron": "0 6 * * *",
"type": "custom_cron"
},
"time": {
"interval": 1,
"type": "every_hour"
}
},
"settings": {
"target_name": "default",
"threads": 4
},
"state": 1,
"triggers": {
"git_provider_webhook": false,
"github_webhook": false,
"on_merge": false,
"schedule": true
},
"updated_at": "2026-10-01T09:00:00.000000+00:00"
}
}Wait for run to finish
Wait until a run has succeeded, failed or been cancelled, then return it. The workflow pauses meanwhile, checking every minute.
Inputs
- Run ID
run_idtextRequired - The run's id, from 'Run job', 'List runs' or a trigger.
- Wait at most (minutes)
max_wait_minutesnumber - Fail if the run is still going this long after it was started. Defaults to 60.From 1 to 1440.
Outputs
runobject- The finished run
statustext- How it ended: success, error or cancelled
succeededtrue/false- Whether it succeeded
Example output
{
"run": {
"account_id": 12345,
"artifacts_saved": true,
"can_retry": false,
"created_at": "2026-10-20 06:00:01.000000+00:00",
"dbt_version": "latest",
"dequeued_at": "2026-10-20 06:00:09.000000+00:00",
"duration": "00:03:03",
"duration_humanized": "3 minutes, 3 seconds",
"environment_id": 218762,
"finished_at": "2026-10-20 06:03:04.000000+00:00",
"git_branch": "main",
"git_sha": "8d1f2a7c",
"has_docs_generated": true,
"href": "https://cloud.getdbt.com/deploy/12345/projects/270542/runs/70403103/",
"id": 70403103,
"in_progress": false,
"is_cancelled": false,
"is_complete": true,
"is_error": false,
"is_success": true,
"job": {
"id": 567183,
"name": "Daily build",
"project_id": 270542
},
"job_definition_id": 567183,
"job_id": 567183,
"project_id": 270542,
"retrying_run_id": 0,
"run_duration_humanized": "2 minutes, 44 seconds",
"run_steps": [
{
"account_id": 12345,
"debug_logs": "",
"duration": "00:02:41",
"duration_humanized": "2 minutes, 41 seconds",
"finished_at": "2026-10-20 06:03:02.000000+00:00",
"id": 412000001,
"index": 1,
"logs": "Completed successfully\nDone. PASS=42 WARN=0 ERROR=0 SKIP=0 TOTAL=42",
"name": "Invoke dbt with `dbt build`",
"run_id": 70403103,
"started_at": "2026-10-20 06:00:21.000000+00:00",
"status": 10,
"status_humanized": "Success",
"truncated_debug_logs": ""
}
],
"started_at": "2026-10-20 06:00:20.000000+00:00",
"status": 10,
"status_humanized": "Success",
"status_message": "",
"trigger": {
"cause": "Started by a Lodol workflow",
"cause_category": "api",
"git_branch": "",
"git_sha": "",
"job_definition_id": 567183,
"schema_override": "",
"steps_override": []
},
"trigger_id": 71000001,
"updated_at": "2026-10-20 06:03:05.000000+00:00"
},
"status": "success",
"succeeded": true
}