Working with branches

Learn how to develop and manage your Supabase branches

This guide covers how to work with Supabase branches effectively, including migration management, seeding behavior, and development workflows.

Subscribing to notifications#

You can subscribe to webhook notifications when an action run completes on a persistent branch. The payload format follows the webhook standards.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
{  "type": "run.completed",  "timestamp": "2025-10-17T02:27:18.705861793Z",  "data": {    "project_ref": "xuqpsshjxdecrwdyuxvs",    "details_url": "https://supabase.com/dashboard/project/xuqpsshjxdecrwdyuxvs/branches",    "action_run": {      "id": "d5f8b4298d0a4d37b99e255c7837e7af",      "created_at": "2025-10-17T02:27:10.133329324Z"      "steps": [        {          "name": "clone",          "status": "exited",          "updated_at": "2025-10-17T02:27:10.788435466Z"        },        {          "name": "pull",          "status": "exited",          "updated_at": "2025-10-17T02:27:11.701742857Z"        },        {          "name": "health",          "status": "exited",          "updated_at": "2025-10-17T02:27:12.79205717Z"        },        {          "name": "configure",          "status": "exited",          "updated_at": "2025-10-17T02:27:13.726839657Z"        },        {          "name": "migrate",          "status": "exited",          "updated_at": "2025-10-17T02:27:14.97017507Z"        },        {          "name": "seed",          "status": "exited",          "updated_at": "2025-10-17T02:27:15.637684921Z"        },        {          "name": "deploy",          "status": "exited",          "updated_at": "2025-10-17T02:27:18.604193114Z"        }      ]    }  }}

We recommend registering a single webhooks processor that dispatches events to downstream services based on the payload type. The easiest way to do that is by deploying an Edge Function. For example, the following Edge Function listens for run completed events to notify a Slack channel.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
// Setup type definitions for built-in Supabase Runtime APIsimport 'jsr:@supabase/functions-js/edge-runtime.d.ts'console.log('Branching notification booted!')const slack = Deno.env.get('SLACK_WEBHOOK_URL') ?? ''Deno.serve(async (request) => {  const body = await request.json()  const blocks = [    {      type: 'header',      text: {        type: 'plain_text',        text: `Action run ${body.data.action_run.failure ? 'failed' : 'completed'}`,        emoji: true,      },    },    {      type: 'section',      fields: [        {          type: 'mrkdwn',          text: `*Branch ref:*\n${body.data.project_ref}`,        },        {          type: 'mrkdwn',          text: `*Run ID:*\n${body.data.action_run.id}`,        },      ],    },    {      type: 'section',      fields: [        {          type: 'mrkdwn',          text: `*Started at:*\n${body.data.action_run.created_at}`,        },        {          type: 'mrkdwn',          text: `*Completed at:*\n${body.timestamp}`,        },      ],    },    {      type: 'section',      text: {        type: 'mrkdwn',        text: `<${body.data.details_url}|View logs>`,      },    },  ]  const resp = await fetch(slack, {    method: 'POST',    body: JSON.stringify({      blocks,    }),  })  const message = await resp.text()  return new Response(    JSON.stringify({      message,    }),    {      status: 200,    }  )})

1
supabase secrets set --project-ref <branch-ref> SLACK_WEBHOOK_URL=<your-webhook-url>

1
supabase functions deploy --project-ref <branch-ref> --use-api notify-slack

1
supabase branches update <branch-ref> --notify-url https://<branch-ref>.supabase.co/functions/v1/notify-slack

After completing the steps above, you should receive a Slack message whenever an action run completes on your target branch.

Migration and seeding behavior#

Migrations are run in sequential order. Each migration builds upon the previous one.

The preview branch has a record of which migrations have been applied, and only applies new migrations for each commit. This can create an issue when rolling back migrations.

Using ORM or custom seed scripts#

If you want to use your own ORM for managing migrations and seed scripts, you will need to run them in GitHub Actions after the preview branch is ready. The branch credentials can be fetched using the following example GHA workflow.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
name: Custom ORMon:  pull_request:    types:      - opened      - reopened      - synchronize    branches:      - main    paths:      - 'supabase/**'jobs:  wait:    runs-on: ubuntu-latest    outputs:      status: ${{ steps.check.outputs.conclusion }}    steps:      - uses: fountainhead/action-wait-for-check@v1.2.0        id: check        with:          checkName: Supabase Preview          ref: ${{ github.event.pull_request.head.sha || github.sha }}          token: ${{ secrets.GITHUB_TOKEN }}  migrate:    needs:      - wait    if: ${{ needs.wait.outputs.status == 'success' }}    runs-on: ubuntu-latest    env:      SUPABASE_ACCESS_TOKEN: ${{ secrets.SUPABASE_ACCESS_TOKEN }}      SUPABASE_PROJECT_ID: ${{ secrets.SUPABASE_PROJECT_ID }}    steps:      - uses: supabase/setup-cli@v1        with:          version: latest      - run: supabase --experimental branches get "$GITHUB_HEAD_REF" -o env >> $GITHUB_ENV      - name: Custom ORM migration        run: psql "$POSTGRES_URL_NON_POOLING" -c 'select 1'

Rolling back migrations#

You might want to roll back changes you've made in an earlier migration change. For example, you may have pushed a migration file containing schema changes you no longer want.

To fix this, push the latest changes, then delete the preview branch in Supabase and reopen it.

The new preview branch is reseeded from the ./supabase/seed.sql file by default. Any additional data changes made on the old preview branch are lost. This is equivalent to running supabase db reset locally. All migrations are rerun in sequential order.

Seeding behavior#

Your Preview Branches are seeded with sample data using the same as local seeding behavior.

The database is only seeded once, when the preview branch is created. To rerun seeding, delete the preview branch and recreate it by closing, and reopening your pull request.

Developing with branches#

You can develop with branches using either local or remote development workflows.

Local development workflow#

1. Create a new Git branch for your feature
2. Make schema changes using the Supabase CLI
3. Generate migration files with supabase db diff
4. Test your changes locally
5. Commit and push to GitHub
6. Open a pull request to create a preview branch

Remote development workflow#

1. Create a preview branch in the Supabase dashboard
2. Switch to the branch using the branch dropdown
3. Make schema changes in the dashboard
4. Pull changes locally using supabase db pull
5. Commit the generated migration files
6. Push to your Git repository

Managing branch environments#

Switching between branches#

Use the branch dropdown in the Supabase dashboard to switch between different branches. Each branch has its own:

• Database instance
• API endpoints
• Authentication settings
• Storage buckets

Accessing branch credentials#

Each branch has unique credentials that you can find in the dashboard:

1. Switch to your desired branch
2. Navigate to Settings > API
3. Copy the branch-specific URLs and keys

Branch isolation#

Branches are completely isolated from each other. Changes made in one branch don't affect others, including:

• Database schema and data
• Storage objects
• Edge Functions
• Auth configurations

Next steps#

• Learn about branch configuration
• Explore integrations
• Review troubleshooting guide