Skip to main content

Supabase

Getting started​

We will see how to build Windmill workflow that's triggered by the Supabase Database Webhooks.

tip

Supabase Database Webhooks allow you to send real-time data from your database to Windmill whenever a table event occurs. You can hook into three table events: INSERT, UPDATE, and DELETE. All events are fired after a database row is changed.

We will leverage Windmill Webhooks that allow triggering Windmill scripts or Windmill flows via HTTP POST request.

Check Supabase event structure​

Let's create a simple Windmill script to test the integration and preview the structure of Supabase events (official Supabase specification can be found at https://supabase.com/docs/guides/database/webhooks#payload).

create script

typescript example

The idea here is just to sneak peak incoming event from Supabase so we will create a void script, use it's webhook and inspect the logs of script run that was triggered by Supabase.

Void script​

void script

Webhook URL​

There are two kinds of Windmill Webhooks: Hash and Path. Let's copy the Hash one. For more details check Windmill Webhooks docs.

danger

If you've chosen Hash webhook and you later modify your script then your script will have a new Hash webhook URL. The previous webhook Hash URL will still run the old version of the script!

If your intention is that later script modifications should propagate to previously created webhooks, then you should use the Path webhook URL.

caution

Webhook URLs should be treated as a secret

webhook url

Save the URL somewhere, we will need it a bit later.

info

Windmill flows also have their webhook URLs

Windmill token used by Supabase​

HTTP POST request done by Supabase will have to be authorized. Let's create dedicated token.

create token

Make sure to label the token with some meaningful name.

tip

It's a good idea to have a dedicated tokens per integration.

Optionally you can put an expiration date, so that the token will expire after e.g. 3 months.

danger

Setting token lifetime is aligned "good security practices" point of view but on the other hand you might not remember to rotate it and the integration will stop working at some point.

for supabase

Remember to copy the token after creating it. Later you will not be able to do this.

copy token

caution

Tokens should be treated as a secret

Save the token value somewhere, we will still need it a bit later in this tutorial.

Hook into Supabase database table events​

Now we can go to our Supabase "Database Webhooks" view and create some database webhook:

create supabase webhook

Make sure to have some meaningful name, subscribe to INSERT, UPDATE and DELETE and select the HTTP Request hook type:

subabase webhook preferences

Make sure to select the POST HTTP Request method, paste the windmill webhook URL and add Authorization header that contains the token (e.g. Authorization: Bearer SuperSecretToken).

caution

Notice the Bearer keyword and the space before the actual token

subabase webhook integration

Congratulations! We're hooked in!

subabase webhook created

Test integration​

Let's check if it works. So let's log in to our Supabase PostgreSQL database and do some INSERT into the table where we're "hooked in":

SQL insert

OK, so we've inserted a new row into the table in the Supabase PostgreSQL database. The event should be propagated to Windmill and trigger our void script. Do you remember that we've created this script to sneak peak the data structure passed from Supabase to Windmill? Let's check it out!

If the script was indeed triggered we should see the result in the "Runs" view:

Runs view

WOW, we can see that something indeed ran our script: script triggered by supabase event

Let's check the logs and other details: script run

Cool! Now we know what kind of information is transmitted from Supabase.

Process the Supabase event​

We can now process the Supabase event in our script. So let's modify it so that it's no longer void!

edit script

script not void anymore

caution

If you used Windmill Webhook Hash URL in previous steps, then you will need to create a new Supabase Database Webhook - otherwise old version of the script will be triggered.

This script is also available on WindmillHub: https://hub.windmill.dev/scripts/supabase/1455/preview-supabase-event-supabase

Other database events​

So the event generated for UPDATE looks like this:

UPDATE event

... and here is the DELETE:

DELETE event

Powerful workflow​

It should be already clear that the combination of Windmill and Supabase allows you to build powerful workflows. You can find more flow examples here: https://hub.windmill.dev/flows

Just remember that Windmill Flows also expose webhook URL.