DBT TriggerRun

DBT TriggerRun

Certified

Start a dbt Cloud job run

Triggers a dbt Cloud job via API. Optionally waits for completion to stream logs, surface dynamic steps, and collect run results; wait defaults to true with 5s polling and a 60m cap.

yaml
type: io.kestra.plugin.dbt.cloud.TriggerRun
yaml
id: dbt_trigger_job_run
namespace: company.team

tasks:
  - id: trigger_run
    type: io.kestra.plugin.dbt.cloud.TriggerRun
    accountId: "dbt_account"
    token: "{{ secret('DBT_TOKEN') }}"
    jobId: "job_id"
Properties

Numeric ID of the account

Job ID

Numeric dbt Cloud job identifier to trigger.

API key

Defaulthttps://cloud.getdbt.com

Base URL to select the tenant

DefaultTriggered by Kestra.

Run cause

Reason passed to dbt Cloud. Defaults to "Triggered by Kestra."

dbt version override

dbt version string to force for this run.

Generate docs override

Whether the run builds docs even if the job is configured otherwise.

Git branch override

Branch to checkout when triggering the job.

Git SHA override

Specific commit to checkout before the run.

Default1000

Initial delay in milliseconds before retrying

Default: 1000 ms (1 second)

DefaultPT1H

Max wait duration

Ceiling for waiting on job completion. Default 60m.

Default3

Maximum number of retries in case of transient errors

Default: 3

The HTTP client configuration

Definitions
allowFailedbooleanstring
Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray
SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

type*Requiredobject
passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

type*Requiredobject
tokenstring

The token for bearer token authentication.

type*Requiredobject
passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

basicAuthPasswordDeprecatedstring

The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

basicAuthUserDeprecatedstring

The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

connectTimeoutDeprecatedstring
Formatduration

The time allowed to establish a connection to the server before failing.

connectionPoolIdleTimeoutDeprecatedstring
Formatduration

The time an idle connection can remain in the client's connection pool before being closed.

defaultCharsetstring
DefaultUTF-8

The default charset for the request.

enabledTcpExtendedKeepAlivebooleanstring
Defaulttrue

Whether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).

Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.

followRedirectsbooleanstring
Defaulttrue

Whether redirects should be followed automatically.

logLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIED

The log level for the HTTP client.

logsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

maxContentLengthDeprecatedinteger

The maximum content length of the response.

proxy

The proxy configuration.

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring
DefaultDIRECT
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

proxyAddressDeprecatedstring

The address of the proxy server.

proxyPasswordDeprecatedstring

The password for proxy authentication.

proxyPortDeprecatedinteger

The port of the proxy server.

proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

proxyUsernameDeprecatedstring

The username for proxy authentication.

readIdleTimeoutDeprecatedstring
Formatduration

The time allowed for a read connection to remain idle before closing it.

readTimeoutDeprecatedstring
Formatduration

The maximum time allowed for reading data from the server before failing.

ssl

The SSL request options

insecureTrustAllCertificatesbooleanstring

Whether to disable checking of the remote SSL certificate.

Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.

timeout

The timeout configuration.

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring
DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

Defaulttrue

Parse run results

If true (default), parses dbt run results to expose node durations and warnings.

Reference (ref) of the pluginDefaults to apply to this task.

DefaultPT5S

Poll frequency

Interval between status checks when waiting. Default 5s.

Schema override

Destination schema to use instead of the job target default.

SubTypestring

Steps override

Custom steps list executed instead of the job defaults.

Target name override

Value for the target.name context variable.

Threads override

Thread count for the run.

Timeout override

Job timeout in seconds for this run.

Defaulttrue

Wait for completion

If true (default), polls dbt Cloud until the run ends and streams logs and artifacts.

Formaturi

Manifest URI

Internal storage URI for manifest.json, when available.

Run ID

dbt Cloud run identifier returned by the trigger call.

Formaturi

Run results URI

Internal storage URI for run_results.json, when available.

More Plugins in this Category

Clickhouse
Clickhouse

Tasks that connect to ClickHouse via JDBC to run queries and loads.

Data

5 tasks

2 blueprints

Weaviate
Weaviate

Tasks that manage and query vectors in Weaviate.

DataAI

4 tasks

2 blueprints