Databricks

Databases Workspace URL and access token

Run jobs, manage clusters and query SQL warehouses on Databricks from any Windmill script, flow or app.

Set up in 3 steps

1

Create a personal access token

In your Databricks workspace, open Settings then Developer, and generate an access token.

2

Add the resource in Windmill

Open Resources, add a resource of type databricks. workspace_url is your own deployment host — there is no shared Databricks API host — and token is the access token.

3

Run your first script

Fork any script below and read before writing anything.

Scripts

Building blocks, if none of the projects above fit. Fork one, run it, or call it as a step inside your own flow.

Submit a script →

Trigger flows from Databricks

Databricks is not only a destination. These inbound paths are supported today.

Completed job run (scheduled poll)

The New Completed Job Run trigger script polls the workspace and returns the job runs that finished since its last run, optionally for one job. To run it, open a flow, add a trigger and choose Scheduled Poll, then pick the trigger script and an interval. Windmill puts the script first in the flow with a loop after it, so the steps you add run once per new item. The cursor is saved per flow: two flows polling the same source each get every item, and test runs keep a cursor of their own.

Resource type

The shape of the credential every script on this page expects.

FieldTypeRequiredWhat it is
http_pathstringNoHTTP path of the SQL warehouse or cluster to run against, e.g. /sql/1.0/warehouses/a1b2c3d4e5f6. Found under the compute resource's Connection details. Required by dbt; not needed by the REST API.
tokenstringYesPersonal access token. Generate one under User Settings > Developer > Access tokens, or at https://<workspace_url>/settings/user/developer/access-tokens.
workspace_urlstringYesWorkspace deployment URL, e.g. https://dbc-a1b2c3d4-e5f6.cloud.databricks.com (AWS), https://adb-1234567890123456.7.azuredatabricks.net (Azure), or https://1234567890123456.7.gcp.databricks.com (GCP). No trailing slash.

Questions

What is http_path for?

The SQL warehouse or cluster a dbt run should target, found under its Connection details. The REST scripts here do not need it.

Everything 404s

Usually a trailing slash on workspace_url, or the wrong workspace. Every call is built from that host — Databricks has no shared API domain.

Is my token stored on the hub?

Never. It lives only in your own Windmill workspace, encrypted at rest.