Supabase

Databases Project URL and API key Windmill docs

Query a Supabase project from any Windmill script, flow or app — through the REST API with a project key, or straight over the Postgres protocol.

Set up in 3 steps

1

Copy the project URL and key

In Supabase, open Project Settings then API. Take the project URL and one of the keys shown there.

2

Add the resource in Windmill

Open Resources, add a resource of type supabase, and fill url and key.

3

Run your first script

Fork any script below. To query tables directly instead, add a postgresql resource — Supabase exposes the standard Postgres protocol.

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 →

Authenticate with email and password

Script supabase Verified

Upsert data

Script supabase Verified

Delete data

Script supabase Verified

Update data

Script supabase Verified

Fetch data

Script supabase Verified

preview supabase event

Script supabase Verified

Insert data

Script supabase Verified

Updates project's supavisor config

Script supabase Verified

Updates project's storage config

Script supabase Verified

Updates project's postgrest config

Script supabase Verified

Updates project's Postgres config

Script supabase Verified

Updates a project's auth config

Script supabase Verified

Updates a SSO provider by its UUID

Script supabase Verified

Update database branch config

Script supabase Verified

Update a function

Script supabase Verified

Revokes project claim token

Script supabase Verified

Returns project's readonly mode status

Script supabase Verified

Retrieve a function body

Script supabase Verified

Retrieve a function

Script supabase Verified

Restores the given project

Script supabase Verified

Restores a PITR backup for a database

Script supabase Verified

Resets a database branch

Script supabase Verified

Removes project addon

Script supabase Verified

Removes a third-party auth integration

Script supabase Verified

Removes a SSO provider by its UUID

Script supabase Verified

Pushes a database branch

Script supabase Verified

Pauses the given project

Script supabase Verified

Merges a database branch

Script supabase Verified

Lists project addons

Script supabase Verified

Lists available restore versions for the given project

Script supabase Verified

Flows

Multi-step workflows that already wire Supabase to something else.

All flows →

Resource types

The credential shapes the scripts on this page expect — pick the one your script asks for.

FieldTypeRequiredWhat it is
keystringNoThe unique Supabase Key which is supplied when you create a new project in your project dashboard.
urlstringNoThe unique Supabase URL which is supplied when you create a new project in your project dashboard.

supabase access token

View raw schema →
FieldTypeRequiredWhat it is
accessTokenstringYesFound at https://supabase.com/dashboard/account/tokens

Questions

Which key should I use?

The public key is bound by your row level security policies; the secret one bypasses them all. A resource is never sent to a script's caller, so the secret key is safe here — but it means your policies stop protecting you, so use the public key when they are what you rely on.

REST API or Postgres?

Use this resource for the REST and storage APIs. For plain SQL, add a postgresql resource against the same project — Windmill runs SQL natively and can trigger runs on INSERT, UPDATE or DELETE.

Do I need an external database at all?

Not always. Windmill data tables are managed relational storage, scoped to a workspace, with no connection string to configure or hand out. Reach for Supabase when it is already your database, or when something outside Windmill has to read it too.

Is my key stored on the hub?

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