Database

Database Webhooks

Trigger external payloads on database events.

Database Webhooks allow you to send real-time data from your database to another system 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.

Webhooks vs triggers

Database Webhooks are very similar to triggers, and that's because Database Webhooks are just a convenience wrapper around triggers using the pg_net extension. This extension is asynchronous, and therefore will not block your database changes for long-running network requests.

This video demonstrates how you can create a new customer in Stripe each time a row is inserted into a profiles table:

Creating a webhook

  1. Create a new Database Webhook in the Dashboard.
  2. Give your Webhook a name.
  3. Select the table you want to hook into.
  4. Select one or more events (table inserts, updates, or deletes) you want to hook into.

Since webhooks are just database triggers, you can also create one from SQL statement directly.

1
2
3
4
5
6
7
8
9
create trigger "my_webhook" after inserton "public"."my_table" for each rowexecute function "supabase_functions"."http_request"(  'http://host.docker.internal:3000',  'POST',  '{"Content-Type":"application/json"}',  '{}',  '1000');

We currently support HTTP webhooks. These can be sent as POST or GET requests with a JSON payload.

Payload

The payload is automatically generated from the underlying table record:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
type InsertPayload = {  type: 'INSERT'  table: string  schema: string  record: TableRecord<T>  old_record: null}type UpdatePayload = {  type: 'UPDATE'  table: string  schema: string  record: TableRecord<T>  old_record: TableRecord<T>}type DeletePayload = {  type: 'DELETE'  table: string  schema: string  record: null  old_record: TableRecord<T>}

Monitoring

Logging history of webhook calls is available under the net schema of your database. For more info, see the GitHub Repo.

Local development

When using Database Webhooks on your local Supabase instance, you need to be aware that the Postgres database runs inside a Docker container. This means that localhost or 127.0.0.1 in your webhook URL will refer to the container itself, not your host machine where your application is running.

To target services running on your host machine, use host.docker.internal. If that doesn't work, you may need to use your machine's local IP address instead.

For example, if you want to trigger an edge function when a webhook fires, your webhook URL would be:

1
http://host.docker.internal:54321/functions/v1/my-function-name

If you're experiencing connection issues with webhooks locally, verify you're using the correct hostname instead of localhost.

Resources

  • pg_net: an async networking extension for Postgres