Skip to docs navigation

Databricks integration guide

Verified

How to connect Databricks to WEXTL and use its 1 trigger and 113 actions in your workflows. About Databricks: Run Databricks jobs, clusters, SQL, files, Unity Catalog, and model serving from a workspace.

  • 1 trigger
  • 44 searches
  • 69 actions
  • Polling
  • Auth: API key
  • Auth: OAuth

AI-assisted documentation18 min read

This documentation is compiled from our integration source code, internal specs for Databricks, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Databricks on WEXTL →
  • Databricks
  • WEXTL
  • Bitbucket
  • Figma
  • GitHub
  • Cortex
  • Dropbox
  • Cloudflare
  • Bunny.net
  • AWS Cognito
  • AWS Lambda
  • Clerk
  • Fynk
  • Bitwarden
  • Documenso
  • Azure Storage
  • AssemblyAI
  • Cockpit
  • Adafruit
  • GetScreenshot
  • CircleCI
  • AWS S3
  • Apify
  • Box
  • Agenty
  • CloudConvert
  • Currents
  • Crowdin
  • Bright Data
  • Browse AI
  • Contentful
Credential type option 1

Databricks - API Key

  • Workspace URLtextRequired

    Workspace origin including protocol, no trailing slash and no /api. Example: https://dbc-a1b2345c-d6e7.cloud.databricks.com. Azure looks like https://adb-xxxx.azuredatabricks.net.[1]

  • API KeypasswordRequired

    Settings → Developer → Access tokens. Sent as Authorization: Bearer. Treat it like a password.[1]

Credential type option 2

Databricks

You’ll be redirected to sign in and approve access — your password is never shared with WEXTL.

  • Workspace URLtextRequired

    Same origin rule as PAT. Must be the workspace URL, not https://accounts.cloud.databricks.com.[1]

  • Client IDtextRequired

    Service principal application ID (Secrets tab).[1]

  • Client SecretpasswordRequired

    OAuth secret. Shown once. Treat it like a password.[1]

Integration requests 1 permission:

  • all-apis
  1. Log in to your WEXTL account, add the Databricks node module to your workflow, and click Create new credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Databricks account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Job Runs

Trigger
Input fields[3]
FieldType
Jobchoice
Limitnumber
Output fields[3]
FieldType
Run Idnumber
Run Nametext
Stateobject
Life Cycle Statetext
Result Statetext
Job Idnumber
Start Timenumber

Get Catalog

Search
Input fields[3]
FieldType
NameRequired
text
Output fields[3]
FieldType
Idtext
Nametext

Get Cluster

Search
Input fields[3]
FieldType
ClusterRequired
choice
Output fields[3]
FieldType
Idtext
Nametext

Get Conversation Message

Search
Input fields[3]
FieldType
SpaceRequired
choice
ConversationRequired
choice
MessageRequired
choice
Output fields[3]
FieldType
Idtext
Nametext

Get File Metadata

Search
Input fields[3]
FieldType
File PathRequired
text
Output fields[3]
FieldType
Content Lengthtext
Content Typetext
Last Modifiedtext

Get Function

Search
Input fields[3]
FieldType
Full NameRequired
text
Output fields[3]
FieldType
Idtext
Nametext

Get Genie Space

Search
Input fields[3]
FieldType
Space IdRequired
text
Output fields[3]
FieldType
Idtext
Nametext

Get Job

Search
Input fields[3]
FieldType
JobRequired
choice
Output fields[3]
FieldType
Idtext
Nametext

Get Job Run

Search
Input fields[3]
FieldType
RunRequired
choice
Output fields[3]
FieldType
Idtext
Nametext

Get Job Run Output

Search
Input fields[3]
FieldType
RunRequired
choice
Output fields[3]
FieldType
Idtext
Nametext

Get Query Results

Search
Input fields[3]
FieldType
SpaceRequired
choice
ConversationRequired
choice
MessageRequired
choice
Attachment IdRequired
text
Output fields[3]
FieldType
Idtext
Nametext

Get Repo

Search
Input fields[3]
FieldType
RepoRequired
choice
Output fields[3]
FieldType
Idtext
Nametext

Get Schema

Search
Input fields[3]
FieldType
Full NameRequired
text
Output fields[3]
FieldType
Idtext
Nametext

Get Secret ACL

Search
Input fields[3]
FieldType
ScopeRequired
choice
PrincipalRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

Get Serving Endpoint

Search
Input fields[3]
FieldType
NameRequired
text
Output fields[3]
FieldType
Idtext
Nametext

Get SQL Statement

Search
Input fields[3]
FieldType
Statement IdRequired
text
Output fields[3]
FieldType
Idtext
Nametext

Get SQL Statement Result Chunk

Search
Input fields[3]
FieldType
Statement IdRequired
text
Chunk IndexRequired
number
Output fields[3]
FieldType
Idtext
Nametext

Get SQL Warehouse

Search
Input fields[3]
FieldType
Warehouse IdRequired
text
Output fields[3]
FieldType
Idtext
Nametext

Get Table

Search
Input fields[3]
FieldType
Full NameRequired
text
Output fields[3]
FieldType
Idtext
Nametext

Get Vector Search Index

Search
Input fields[3]
FieldType
Index NameRequired
text
Output fields[3]
FieldType
Idtext
Nametext

Get Volume

Search
Input fields[3]
FieldType
Full NameRequired
text
Output fields[3]
FieldType
Idtext
Nametext

Get Workspace Object Status

Search
Input fields[3]
FieldType
PathRequired
text
Output fields[3]
FieldType
Idtext
Nametext

List Availability Zones

Search
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Catalogs

Search
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Nametext
Commenttext

List Cluster Events

Search
Input fields[3]
FieldType
ClusterRequired
choice
ClusterRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Clusters

Search
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Cluster Idtext
Cluster Nametext
Statetext

List Directory

Search
Input fields[3]
FieldType
Directory PathRequired
text
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Functions

Search
Input fields[3]
FieldType
CatalogRequired
choice
SchemaRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Genie Spaces

Search
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Job Runs

Search
Input fields[3]
FieldType
Jobchoice
Active Onlyboolean
Completed Onlyboolean
Run Typechoice
LimitRequired
number
Output fields[3]
FieldType
Run Idnumber
Run Nametext
Start Timenumber
Job Idnumber

List Jobs

Search
Input fields[3]
FieldType
Nametext
Expand Tasksboolean
LimitRequired
number
Output fields[3]
FieldType
Job Idnumber
Settingsobject
Nametext

List Node Types

Search
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Repos

Search
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Schemas

Search
Input fields[3]
FieldType
CatalogRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Secret ACLs

Search
Input fields[3]
FieldType
ScopeRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Secret Scopes

Search
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Secrets

Search
Input fields[3]
FieldType
ScopeRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Serving Endpoints

Search
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Spark Versions

Search
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List SQL Warehouses

Search
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Tables

Search
Input fields[3]
FieldType
CatalogRequired
choice
SchemaRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Vector Search Endpoints

Search
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Vector Search Indexes

Search
Input fields[3]
FieldType
EndpointRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Volumes

Search
Input fields[3]
FieldType
CatalogRequired
choice
SchemaRequired
choice
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

List Workspace Objects

Search
Input fields[3]
FieldType
PathRequired
text
LimitRequired
number
Output fields[3]
FieldType
Idtext
Nametext

Cancel All Runs

Action
Input fields[3]
FieldType
JobRequired
choice
Output fields[3]
FieldType
Status Codenumber

Cancel Run

Action
Input fields[3]
FieldType
RunRequired
choice
Output fields[3]
FieldType
Status Codenumber

Cancel SQL Statement

Action
Input fields[3]
FieldType
Statement IdRequired
text
Output fields[3]
FieldType
Status Codenumber

Change Cluster Owner

Action
Input fields[3]
FieldType
ClusterRequired
choice
Owner UsernameRequired
text
Output fields[3]
FieldType
Status Codenumber

Create Catalog

Action
Input fields[3]
FieldType
NameRequired
text
Commenttext
Storage Roottext
Propertiesarray
Output fields[3]
FieldType
Nametext

Create Cluster

Action
Input fields[3]
FieldType
Node TypeRequired
choice
Spark VersionRequired
choice
Cluster NameRequired
text
Num Workersnumber
Autotermination Minutesnumber
Enable Elastic Diskboolean
Driver Node Typechoice
Aws Attributesobject
Zone IdRequired
choice
Availabilitychoice
Spot Bid Price Percentnumber
Spark Confarray
Spark Env Varsarray
Custom Tagsarray

2other input fields

Output fields[3]
FieldType
Cluster Idtext

Create Conversation Message

Action
Input fields[3]
FieldType
SpaceRequired
choice
ConversationRequired
choice
ContentRequired
text
Output fields[3]
FieldType
Message Idtext

Create Directory

Action
Input fields[3]
FieldType
Directory PathRequired
text
Output fields[3]
FieldType
Status Codenumber

Create Function

Action
Input fields[3]
FieldType
CatalogRequired
choice
SchemaRequired
choice
NameRequired
text
Input Paramsarray
Data TypeRequired
text
Full Data Typetext
Return Paramsarray
Routine BodyRequired
choice
Routine DefinitionRequired
text
Commenttext
External Languagetext

3other input fields

Output fields[3]
FieldType
Status Codenumber

Create Job

Action
Input fields[3]
FieldType
NameRequired
text
Timeout Secondsnumber
Max Concurrent Runsnumber
Tagsarray
TasksRequired
array
Queueobject
Enabledboolean
Output fields[3]
FieldType
Job Idnumber

Create Repo

Action
Input fields[3]
FieldType
UrlRequired
text
ProviderRequired
choice
PathRequired
text
Sparse Checkoutobject
Patternsarray
Output fields[3]
FieldType
Repo Idnumber

Create Schema

Action
Input fields[3]
FieldType
CatalogRequired
choice
NameRequired
text
Commenttext
Storage Roottext
Propertiesarray
Output fields[3]
FieldType
Status Codenumber

Create Secret Scope

Action
Input fields[3]
FieldType
ScopeRequired
text
Scope Backend Typechoice
Azure Key Vault Backendobject
Resource Idtext
Dns Nametext
Initial Manage Principaltext
Output fields[3]
FieldType
Status Codenumber

Create Serving Endpoint

Action
Input fields[3]
FieldType
NameRequired
text
ConfigRequired
object
Served Entitiesarray
Route Optimizedboolean
Output fields[3]
FieldType
Status Codenumber

Create SQL Warehouse

Action
Input fields[3]
FieldType
NameRequired
text
Cluster SizeRequired
choice
Auto Stop Minsnumber
Min Num Clustersnumber
Max Num Clustersnumber
Enable Photonboolean
Enable Serverless Computeboolean
Warehouse Typechoice
Tagsarray
Output fields[3]
FieldType
Warehouse Idtext

Create Vector Search Index

Action
Input fields[3]
FieldType
EndpointRequired
choice
NameRequired
text
Primary KeyRequired
text
Index TypeRequired
choice
Delta Sync Index Specobject
Source Tabletext
Pipeline Idtext
Embedding Source Columnsarray
Output fields[3]
FieldType
Status Codenumber

Create Volume

Action
Input fields[3]
FieldType
CatalogRequired
choice
SchemaRequired
choice
NameRequired
text
Volume TypeRequired
choice
Commenttext
Storage Locationtext
Output fields[3]
FieldType
Status Codenumber

Create Workspace Directory

Action
Input fields[3]
FieldType
PathRequired
text
Output fields[3]
FieldType
Status Codenumber

Delete Catalog

Action
Input fields[3]
FieldType
NameRequired
text
Output fields[3]
FieldType
Status Codenumber

Delete Cluster Permanently

Action
Input fields[3]
FieldType
ClusterRequired
choice
Output fields[3]
FieldType
Status Codenumber

Delete Directory

Action
Input fields[3]
FieldType
Directory PathRequired
text
Output fields[3]
FieldType
Status Codenumber

Delete File

Action
Input fields[3]
FieldType
File PathRequired
text
Output fields[3]
FieldType
Status Codenumber

Delete Function

Action
Input fields[3]
FieldType
Full NameRequired
text
Output fields[3]
FieldType
Status Codenumber

Delete Job

Action
Input fields[3]
FieldType
JobRequired
choice
Output fields[3]
FieldType
Status Codenumber

Delete Repo

Action
Input fields[3]
FieldType
RepoRequired
choice
Output fields[3]
FieldType
Status Codenumber

Delete Run

Action
Input fields[3]
FieldType
RunRequired
choice
Output fields[3]
FieldType
Status Codenumber

Delete Schema

Action
Input fields[3]
FieldType
Full NameRequired
text
Output fields[3]
FieldType
Status Codenumber

Delete Secret

Action
Input fields[3]
FieldType
ScopeRequired
choice
KeyRequired
text
Output fields[3]
FieldType
Status Codenumber

Delete Secret ACL

Action
Input fields[3]
FieldType
ScopeRequired
choice
PrincipalRequired
choice
Output fields[3]
FieldType
Status Codenumber

Delete Secret Scope

Action
Input fields[3]
FieldType
ScopeRequired
text
Output fields[3]
FieldType
Status Codenumber

Delete Serving Endpoint

Action
Input fields[3]
FieldType
NameRequired
text
Output fields[3]
FieldType
Status Codenumber

Delete SQL Warehouse

Action
Input fields[3]
FieldType
Warehouse IdRequired
text
Output fields[3]
FieldType
Status Codenumber

Delete Volume

Action
Input fields[3]
FieldType
Full NameRequired
text
Output fields[3]
FieldType
Status Codenumber

Delete Workspace Object

Action
Input fields[3]
FieldType
PathRequired
text
Recursiveboolean
Output fields[3]
FieldType
Status Codenumber

Download File

Action
Input fields[3]
FieldType
File PathRequired
text
Output fields[3]
FieldType
Status Codenumber

Edit Cluster

Action
Input fields[3]
FieldType
ClusterRequired
choice
Node TypeRequired
choice
Spark VersionRequired
choice
Cluster NameRequired
text
Num Workersnumber
Autotermination Minutesnumber
Enable Elastic Diskboolean
Driver Node Typechoice
Aws Attributesobject
Zone IdRequired
choice
Availabilitychoice
Spot Bid Price Percentnumber
Spark Confarray
Spark Env Varsarray

3other input fields

Output fields[3]
FieldType
Status Codenumber

Edit SQL Warehouse

Action
Input fields[3]
FieldType
Warehouse IdRequired
text
Nametext
Cluster Sizechoice
Auto Stop Minsnumber
Min Num Clustersnumber
Max Num Clustersnumber
Enable Photonboolean
Tagsarray
Output fields[3]
FieldType
Status Codenumber

Execute Message SQL Query

Action
Input fields[3]
FieldType
SpaceRequired
choice
ConversationRequired
choice
MessageRequired
choice
Attachment IdRequired
text
Output fields[3]
FieldType
Status Codenumber

Execute SQL Statement

Action
Input fields[3]
FieldType
WarehouseRequired
choice
StatementRequired
text
Catalogtext
Schematext
Dispositionchoice
Formatchoice
Wait Timeouttext
On Wait Timeoutchoice
Byte Limitnumber
Row Limitnumber
Parametersarray
Output fields[3]
FieldType
Statement Idtext
Statusobject
Statetext

Export Run

Action
Input fields[3]
FieldType
RunRequired
choice
Output fields[3]
FieldType
Status Codenumber

Export Workspace Object

Action
Input fields[3]
FieldType
PathRequired
text
Formatchoice
Output fields[3]
FieldType
Status Codenumber

Import Workspace Object

Action
Input fields[3]
FieldType
PathRequired
text
FormatRequired
choice
Languagechoice
ContentRequired
text
Overwriteboolean
Output fields[3]
FieldType
Status Codenumber

Make an API Call

universal
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Query Stringarray
Bodytext
Output fields[3]
FieldType
Bodytext
Headerstext
Status Codenumber

Pin Cluster

Action
Input fields[3]
FieldType
ClusterRequired
choice
Output fields[3]
FieldType
Status Codenumber

Put Secret

Action
Input fields[3]
FieldType
ScopeRequired
choice
KeyRequired
text
String Valuetext
Bytes Valuetext
Output fields[3]
FieldType
Status Codenumber

Put Secret ACL

Action
Input fields[3]
FieldType
ScopeRequired
choice
PrincipalRequired
text
PermissionRequired
choice
Output fields[3]
FieldType
Status Codenumber

Query Serving Endpoint

Action
Input fields[3]
FieldType
NameRequired
text
Inputtext
Inputstext
Prompttext
Instancestext
Dataframe Recordstext
Dataframe Splitobject
Indexarray
Columnstext
Datatext
Messagesarray
Max Tokensnumber
Nnumber
Stoparray

5other input fields

Output fields[3]
FieldType
Resulttext

Query Vector Search Index

Action
Input fields[3]
FieldType
Index NameRequired
text
Columnsarray
Query Texttext
Query Vectorarray
Filters Jsontext
Num Resultsnumber
Query Typechoice
Output fields[3]
FieldType
Status Codenumber

Repair Run

Action
Input fields[3]
FieldType
RunRequired
choice
Latest Repair Idnumber
Rerun Tasksarray
Jar Paramsarray
Notebook Paramsarray
Python Paramsarray
Output fields[3]
FieldType
Status Codenumber

Reset Job

Action
Input fields[3]
FieldType
JobRequired
choice
New SettingsRequired
object
Nametext
Descriptiontext
Timeout Secondsnumber
Max Concurrent Runsnumber
Tagsarray
Tasksarray
Email Notificationsobject
Git Sourceobject
Queueobject
Output fields[3]
FieldType
Status Codenumber

Resize Cluster

Action
Input fields[3]
FieldType
ClusterRequired
choice
Num WorkersRequired
number
Output fields[3]
FieldType
Status Codenumber

Restart Cluster

Action
Input fields[3]
FieldType
ClusterRequired
choice
Output fields[3]
FieldType
Status Codenumber

Run Now

Action
Input fields[3]
FieldType
JobRequired
choice
Job Parametersarray
Idempotency Tokentext
Performance Targetchoice
Queueobject
Enabledboolean
Onlyarray
Output fields[3]
FieldType
Run Idnumber
Number In Jobnumber

Start Cluster

Action
Input fields[3]
FieldType
ClusterRequired
choice
Output fields[3]
FieldType
Status Codenumber

Start Conversation

Action
Input fields[3]
FieldType
SpaceRequired
choice
ContentRequired
text
Output fields[3]
FieldType
Conversation Idtext
Message Idtext

Start SQL Warehouse

Action
Input fields[3]
FieldType
Warehouse IdRequired
text
Output fields[3]
FieldType
Status Codenumber

Stop SQL Warehouse

Action
Input fields[3]
FieldType
Warehouse IdRequired
text
Output fields[3]
FieldType
Status Codenumber

Submit Run

Action
Input fields[3]
FieldType
Run Nametext
Timeout Secondsnumber
TasksRequired
array
Output fields[3]
FieldType
Run Idnumber

Terminate Cluster

Action
Input fields[3]
FieldType
ClusterRequired
choice
Output fields[3]
FieldType
Status Codenumber

Unpin Cluster

Action
Input fields[3]
FieldType
ClusterRequired
choice
Output fields[3]
FieldType
Status Codenumber

Update Catalog

Action
Input fields[3]
FieldType
NameRequired
text
Commenttext
Propertiesarray
New Nametext
Output fields[3]
FieldType
Status Codenumber

Update Cluster

Action
Input fields[3]
FieldType
ClusterRequired
choice
Num Workersnumber
Autoscaleobject
Min Workersnumber
Max Workersnumber
Output fields[3]
FieldType
Status Codenumber

Update Function

Action
Input fields[3]
FieldType
Full NameRequired
text
Commenttext
Routine Definitiontext
External Languagetext
Output fields[3]
FieldType
Status Codenumber

Update Job

Action
Input fields[3]
FieldType
JobRequired
choice
New Settingsobject
Nametext
Descriptiontext
Timeout Secondsnumber
Max Concurrent Runsnumber
Tagsarray
Tasksarray
Email Notificationsobject
Git Sourceobject
Queueobject
Output fields[3]
FieldType
Status Codenumber

Update Repo

Action
Input fields[3]
FieldType
RepoRequired
choice
Branchtext
Sparse Checkoutobject
Patternsarray
Output fields[3]
FieldType
Status Codenumber

Update Schema

Action
Input fields[3]
FieldType
Full NameRequired
text
Commenttext
Propertiesarray
New Nametext
Output fields[3]
FieldType
Status Codenumber

Update Serving Endpoint Config

Action
Input fields[3]
FieldType
NameRequired
text
Served EntitiesRequired
array
Output fields[3]
FieldType
Status Codenumber

Update Volume

Action
Input fields[3]
FieldType
Full NameRequired
text
Commenttext
New Nametext
Output fields[3]
FieldType
Status Codenumber

Upload File

Action
Input fields[3]
FieldType
File PathRequired
text
DataRequired
text
Overwriteboolean
Output fields[3]
FieldType
Status Codenumber
Headerstext

Look for Databricks templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Databricks Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Databricks.
  4. WEXTL® visual workflow builder data.

Last updated: Sep 1, 2026 09:27

How we write our apps documentation

How we compile these docs — sources, AI's role, and how we verify.