Login with Facebook

To enable Facebook Auth for your project, you need to set up a Facebook OAuth application and add the application credentials to your Supabase Dashboard.

Overview#

Setting up Facebook logins for your application consists of 4 parts:

• Create and configure a Facebook Application on the Facebook Developers Site
• Configure email permissions in your Facebook app (required for Supabase Auth)
• Add your Facebook keys to your Supabase Project
• Add the login code to your Supabase JS Client App

Access your Facebook Developer account#

• Go to developers.facebook.com.
• Click on Log In at the top right to log in.

Create a Facebook app#

• Click on My Apps at the top right.
• Click Create App near the top right.
• Select your app type and click Continue.
• Fill in your app information, then click Create App.
• This should bring you to the screen: Add Products to Your App. (Alternatively you can click on Add Product in the left sidebar to get to this screen.)

The next step requires a callback URL, which looks like this: https://<project-ref>.supabase.co/auth/v1/callback

• Go to your Supabase Project Dashboard
• Click on the Authentication icon in the left sidebar
• Click on Sign In / Providers under the Configuration section
• Click on Facebook from the accordion list to expand and you'll find your Callback URL, you can click Copy to copy it to the clipboard

Set up Facebook login for your Facebook app#

From the Add Products to your App screen:

• Click Setup under Facebook Login
• Skip the Quickstart screen. Instead, in the left sidebar, click Settings under Facebook Login
• Enter your callback URI under Valid OAuth Redirect URIs on the Facebook Login Settings page
• Click Save Changes at the bottom right

Configure email permissions (required)#

You must configure the email permission in your Facebook app's Use Cases:

1. In your Facebook app dashboard, click Use Cases under Build Your App
2. Find Authentication and Account Creation and click the Edit button on the right
3. Verify that both public_profile and email show status Ready for testing
4. If email is not listed, click the Add button next to it

Copy your Facebook app ID and secret#

• Click Settings / Basic in the left sidebar
• Copy your App ID from the top of the Basic Settings page
• Under App Secret click Show then copy your secret
• Make sure all required fields are completed on this screen.

Enter your Facebook app ID and secret into your Supabase project#

• Go to your Supabase Project Dashboard
• In the left sidebar, click the Authentication icon (near the top)
• Click on Providers under the Configuration section
• Click on Facebook from the accordion list to expand and turn Facebook Enabled to ON
• Enter your Facebook Client ID and Facebook Client Secret saved in the previous step
• Click Save

You can also configure the Facebook auth provider using the Management API:

1
# Get your access token from https://supabase.com/dashboard/account/tokens
2
export SUPABASE_ACCESS_TOKEN="your-access-token"
3
export PROJECT_REF="your-project-ref"
4
5
# Configure Facebook auth provider
6
curl -X PATCH "https://api.supabase.com/v1/projects/$PROJECT_REF/config/auth" \
7
  -H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \
8
  -H "Content-Type: application/json" \
9
  -d '{
10
    "external_facebook_enabled": true,
11
    "external_facebook_client_id": "your-facebook-app-id",
12
    "external_facebook_secret": "your-facebook-app-secret"
13
  }'

Add login code to your client app#

1
async function signInWithFacebook() {
2
  const { data, error } = await supabase.auth.signInWithOAuth({
3
    provider: 'facebook',
4
  })
5
6
  if (error) {
7
    console.error('Error signing in with Facebook:', error.message)
8
    return
9
  }
10
11
  // The user will be redirected to Facebook for authentication
12
}

For a PKCE flow, for example in Server-Side Auth, you need an extra step to handle the code exchange. When calling signInWithOAuth, provide a redirectTo URL which points to a callback route. This redirect URL should be added to your redirect allow list.

1
await supabase.auth.signInWithOAuth({
2
  provider,
3
  options: {
4
    redirectTo: `http://example.com/auth/callback`,
5
  },
6
})

At the callback endpoint, handle the code exchange to save the user session.

1
import { NextResponse } from 'next/server'
2
// The client you created from the Server-Side Auth instructions
3
import { createClient } from '@/utils/supabase/server'
4
5
export async function GET(request: Request) {
6
  const { searchParams, origin } = new URL(request.url)
7
  const code = searchParams.get('code')
8
  // if "next" is in param, use it as the redirect URL
9
  let next = searchParams.get('next') ?? '/'
10
  if (!next.startsWith('/')) {
11
    // if "next" is not a relative URL, use the default
12
    next = '/'
13
  }
14
15
  if (code) {
16
    const supabase = await createClient()
17
    const { error } = await supabase.auth.exchangeCodeForSession(code)
18
    if (!error) {
19
      const forwardedHost = request.headers.get('x-forwarded-host') // original origin before load balancer
20
      const isLocalEnv = process.env.NODE_ENV === 'development'
21
      if (isLocalEnv) {
22
        // we can be sure that there is no load balancer in between, so no need to watch for X-Forwarded-Host
23
        return NextResponse.redirect(`${origin}${next}`)
24
      } else if (forwardedHost) {
25
        return NextResponse.redirect(`https://${forwardedHost}${next}`)
26
      } else {
27
        return NextResponse.redirect(`${origin}${next}`)
28
      }
29
    }
30
  }
31
32
  // return the user to an error page with instructions
33
  return NextResponse.redirect(`${origin}/auth/auth-code-error`)
34
}

1
async function signOut() {
2
  const { error } = await supabase.auth.signOut()
3
4
  if (error) {
5
    console.error('Error signing out:', error.message)
6
    return
7
  }
8
9
  // User has been signed out
10
}

Testing your integration#

Facebook apps start in Development mode, which has the following limitations:

• Only users with a role on the app (administrators, developers, testers) can authenticate
• Other users will see an "App Not Setup" error when trying to log in

To add test users:

1. Go to developers.facebook.com and select your app
2. Navigate to App Roles > Roles
3. Add users as Testers, Developers, or Administrators
4. Users must accept the invitation from their Facebook notification settings

Going live with app review#

Before your app can be used by the general public, you need to complete Facebook's App Review process:

1. Complete App Settings: In your Facebook app's Settings > Basic, fill in all required fields including:

   • App Icon
   • Privacy Policy URL
   • Terms of Service URL (if applicable)
   • App Domain

2. Request Permissions: Navigate to App Review > Permissions and Features and request the permissions you need:

   • public_profile - Usually pre-approved
   • email - Requires verification that your app needs email access

3. Submit for Review: Click Submit for Review and provide:

   • Detailed instructions for how Facebook reviewers should test your login flow
   • A screencast video demonstrating the Facebook Login feature
   • Explanation of how user data will be used

4. Wait for Approval: Facebook typically reviews apps within 1-5 business days

For more details, see the Facebook App Review documentation.

Troubleshooting#

"App not setup" error#

This error occurs when a user without a role on your app tries to log in while the app is in Development mode.

Solution: Either add the user as a tester in your Facebook app settings, or complete the App Review process to make your app available to all users.

User's email not returned#

Facebook only returns the email address if:

• The user has a confirmed email on their Facebook account
• Your app has been granted the email permission
• The email permission is marked as "Ready for testing" in Use Cases > Authentication and Account Creation

Solution: Check that the email permission is properly configured in your Facebook app's Use Cases settings.

"Redirect URI mismatch" error#

This error indicates the callback URL configured in Facebook doesn't match the one used during authentication.

Solution: Verify that the Valid OAuth Redirect URIs in your Facebook app settings exactly matches https://<project-ref>.supabase.co/auth/v1/callback. Make sure there are no trailing slashes or typos.

Login works in development but not production#

If login works locally but fails in production, check:

• Your production URL is added to Valid OAuth Redirect URIs in Facebook
• The App ID and Secret in your Supabase dashboard match your Facebook app
• Your Facebook app is in Live mode (not Development mode)

Resources#

• Supabase - Get started for free
• Supabase JS Client
• Facebook Developers Dashboard