Run Job Now with Databricks API on New Webhook Event (Instant) from Supabase API

Pipedream makes it easy to connect APIs for Databricks, Supabase and 2,400+ other apps remarkably fast.

Trigger workflow on

New Webhook Event (Instant) from the Supabase API

Next, do this

Run Job Now with the Databricks API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Supabase trigger and Databricks action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Webhook Event (Instant) trigger
1. Connect your Supabase account
2. Configure Table
3. Optional- Configure Row Identifier
Configure the Run Job Now action
1. Connect your Databricks account
2. Select a Job
3. Optional- Configure JAR Params
4. Optional- Configure Notebook Params
5. Optional- Configure Python Params
6. Optional- Configure Spark Submit Params
7. Optional- Configure Idempotency Token
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Webhook Event (Instant) on Supabase

Description:Emit new event for every `insert`, `update`, or `delete` operation in a table. This source requires user configuration using the Supabase website. More information in the README. [Also see documentation here](https://supabase.com/docs/guides/database/webhooks#creating-a-webhook)

Version:0.0.5

Key:supabase-new-webhook-event

View on GitHub

Supabase Overview#

Supabase is a real-time backend-as-a-service that provides developers with a suite of tools to quickly build and scale their applications. It offers database storage, authentication, instant APIs, and real-time subscriptions. With the Supabase API, you can perform CRUD operations on your database, manage users, and listen to database changes in real time. When integrated with Pipedream, you can automate workflows that react to these database events, synchronize data across multiple services, or streamline user management processes.

Trigger Code#

import base from "../common/base.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "supabase-new-webhook-event",
  name: "New Webhook Event (Instant)",
  description: "Emit new event for every `insert`, `update`, or `delete` operation in a table. This source requires user configuration using the Supabase website. More information in the README. [Also see documentation here](https://supabase.com/docs/guides/database/webhooks#creating-a-webhook)",
  version: "0.0.5",
  type: "source",
  props: {
    ...base.props,
    http: {
      type: "$.interface.http",
    },
  },
  hooks: {
    async deploy() {
      const client = await this.supabase._client();
      const query = client
        .from(this.table)
        .select()
        .range(0, constants.HISTORICAL_EVENT_LIMIT);
      const { data } = await query;
      for (const row of data) {
        this.$emit({
          record: row,
        }, {
          summary: "Historical row in table",
        });
      }
    },
  },
  async run(event) {
    const { body: data } = event;
    let summary = `New ${data.type} event in table`;
    if (data.record?.[this.rowIdentifier]) {
      summary = `${summary}: ${data.record[this.rowIdentifier]}`;
    }
    this.$emit(data, {
      summary,
    });
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Supabase	`supabase`	`app`	This component uses the Supabase app.
Table	`table`	`string`	The name of the table to watch for new rows
Row Identifier	`rowIdentifier`	`string`	The column name to use as the row identifier
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.

Trigger Authentication#

Supabase uses API keys for authentication. When you connect your Supabase account, Pipedream securely stores the keys so you can easily authenticate to Supabase APIs in both code and no-code steps.

Supabase provides a Service Key to get started. You can find the service_role in the API Settings page.

Finding the Supabase subdomain

About Supabase#

Supabase is an open source Firebase alternative.

Action#

Run Job Now on Databricks

Description:Run a job now and return the id of the triggered run. [See the documentation](https://docs.databricks.com/en/workflows/jobs/jobs-2.0-api.html#runs-list)

Version:0.0.1

Key:databricks-run-job-now

View on GitHub

Databricks Overview#

The Databricks API allows you to interact programmatically with Databricks services, enabling you to manage clusters, jobs, notebooks, and other resources within Databricks environments. Through Pipedream, you can leverage these APIs to create powerful automations and integrate with other apps for enhanced data processing, transformation, and analytics workflows. This unlocks possibilities like automating cluster management, dynamically running jobs based on external triggers, and orchestrating complex data pipelines with ease.

Action Code#

import databricks from "../../databricks.app.mjs";

export default {
  key: "databricks-run-job-now",
  name: "Run Job Now",
  description: "Run a job now and return the id of the triggered run. [See the documentation](https://docs.databricks.com/en/workflows/jobs/jobs-2.0-api.html#runs-list)",
  version: "0.0.1",
  type: "action",
  props: {
    databricks,
    jobId: {
      propDefinition: [
        databricks,
        "jobId",
      ],
    },
    jarParams: {
      type: "string[]",
      label: "JAR Params",
      description: "A list of parameters for jobs with JAR tasks, e.g. \"jar_params\": [\"john doe\", \"35\"]. The parameters will be used to invoke the main function of the main class specified in the Spark JAR task. If not specified upon run-now, it will default to an empty list. jar_params cannot be specified in conjunction with notebook_params. The JSON representation of this field (i.e. {\"jar_params\":[\"john doe\",\"35\"]}) cannot exceed 10,000 bytes.",
      optional: true,
    },
    notebookParams: {
      type: "object",
      label: "Notebook Params",
      description: "A map from keys to values for jobs with notebook task, e.g. \"notebook_params\": {\"name\": \"john doe\", \"age\":  \"35\"}. The map is passed to the notebook and is accessible through the dbutils.widgets.get function. If not specified upon run-now, the triggered run uses the job’s base parameters. You cannot specify notebook_params in conjunction with jar_params. The JSON representation of this field (i.e. {\"notebook_params\":{\"name\":\"john doe\",\"age\":\"35\"}}) cannot exceed 10,000 bytes.",
      optional: true,
    },
    pythonParams: {
      type: "string[]",
      label: "Python Params",
      description: "A list of parameters for jobs with Python tasks, e.g. \"python_params\": [\"john doe\", \"35\"]. The parameters will be passed to Python file as command-line parameters. If specified upon run-now, it would overwrite the parameters specified in job setting. The JSON representation of this field (i.e. {\"python_params\":[\"john doe\",\"35\"]}) cannot exceed 10,000 bytes.",
      optional: true,
    },
    sparkSubmitParams: {
      type: "string[]",
      label: "Spark Submit Params",
      description: "A list of parameters for jobs with spark submit task, e.g. \"spark_submit_params\": [\"--class\", \"org.apache.spark.examples.SparkPi\"]. The parameters will be passed to spark-submit script as command-line parameters. If specified upon run-now, it would overwrite the parameters specified in job setting. The JSON representation of this field cannot exceed 10,000 bytes.",
      optional: true,
    },
    idempotencyToken: {
      type: "string",
      label: "Idempotency Token",
      description: "An optional token to guarantee the idempotency of job run requests. If a run with the provided token already exists, the request does not create a new run but returns the ID of the existing run instead. If a run with the provided token is deleted, an error is returned. If you specify the idempotency token, upon failure you can retry until the request succeeds. Databricks guarantees that exactly one run is launched with that idempotency token. This token must have at most 64 characters. For more information, see [How to ensure idempotency for jobs](https://kb.databricks.com/jobs/jobs-idempotency.html).",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.databricks.runJobNow({
      data: {
        job_id: this.jobId,
        jar_params: this.jarParams,
        notebook_params: this.notebookParams,
        python_params: this.pythonParams,
        spark_submit_params: this.sparkSubmitParams,
        idempotency_token: this.idempotencyToken,
      },
      $,
    });

    if (response) {
      $.export("$summary", `Successfully initiated job with ID ${this.jobId}.`);
    }

    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Databricks	`databricks`	`app`	This component uses the Databricks app.
Job	`jobId`	`string`	Select a value from the drop down menu.
JAR Params	`jarParams`	`string[]`	A list of parameters for jobs with JAR tasks, e.g. "jar_params": ["john doe", "35"]. The parameters will be used to invoke the main function of the main class specified in the Spark JAR task. If not specified upon run-now, it will default to an empty list. jar_params cannot be specified in conjunction with notebook_params. The JSON representation of this field (i.e. {"jar_params":["john doe","35"]}) cannot exceed 10,000 bytes.
Notebook Params	`notebookParams`	`object`	A map from keys to values for jobs with notebook task, e.g. "notebook_params": {"name": "john doe", "age": "35"}. The map is passed to the notebook and is accessible through the dbutils.widgets.get function. If not specified upon run-now, the triggered run uses the job’s base parameters. You cannot specify notebook_params in conjunction with jar_params. The JSON representation of this field (i.e. {"notebook_params":{"name":"john doe","age":"35"}}) cannot exceed 10,000 bytes.
Python Params	`pythonParams`	`string[]`	A list of parameters for jobs with Python tasks, e.g. "python_params": ["john doe", "35"]. The parameters will be passed to Python file as command-line parameters. If specified upon run-now, it would overwrite the parameters specified in job setting. The JSON representation of this field (i.e. {"python_params":["john doe","35"]}) cannot exceed 10,000 bytes.
Spark Submit Params	`sparkSubmitParams`	`string[]`	A list of parameters for jobs with spark submit task, e.g. "spark_submit_params": ["--class", "org.apache.spark.examples.SparkPi"]. The parameters will be passed to spark-submit script as command-line parameters. If specified upon run-now, it would overwrite the parameters specified in job setting. The JSON representation of this field cannot exceed 10,000 bytes.
Idempotency Token	`idempotencyToken`	`string`	An optional token to guarantee the idempotency of job run requests. If a run with the provided token already exists, the request does not create a new run but returns the ID of the existing run instead. If a run with the provided token is deleted, an error is returned. If you specify the idempotency token, upon failure you can retry until the request succeeds. Databricks guarantees that exactly one run is launched with that idempotency token. This token must have at most 64 characters. For more information, see How to ensure idempotency for jobs.

Action Authentication#

Databricks uses API keys for authentication. When you connect your Databricks account, Pipedream securely stores the keys so you can easily authenticate to Databricks APIs in both code and no-code steps.

To retrieve your Personal Access Token:

Sign in to your Databricks account, and open your Databricks workspace.
From your workspace, click on your username in the top right corner,
Go to “User Settings” > "Developer" > “Access tokens”

Your domain is 1234 if your Databricks instance URL is https://1234.cloud.databricks.com/, except for the Accounts API whose domain is account regardless of instance.

About Databricks#

Databricks is the lakehouse company, helping data teams solve the world’s toughest problems.

More Ways to Connect Databricks + Supabase#

Other Popular Integrations#

List Runs with Databricks API on New Row Added from Supabase API

Supabase + Databricks

Try it

List Runs with Databricks API on New Webhook Event (Instant) from Supabase API

Supabase + Databricks

Try it

Get Run Output with Databricks API on New Row Added from Supabase API

Supabase + Databricks

Try it

Get Run Output with Databricks API on New Webhook Event (Instant) from Supabase API

Supabase + Databricks

Try it

Run Job Now with Databricks API on New Row Added from Supabase API

Supabase + Databricks

Try it

Popular Triggers#

New Row Added from the Supabase API

Emit new event for every new row added in a table. See documentation here

Try it

New Webhook Event (Instant) from the Supabase API

Emit new event for every insert, update, or delete operation in a table. This source requires user configuration using the Supabase website. More information in the README. Also see documentation here

Try it