Skip to main content

If you are using our backend SDK that is lesser than the following versions, please visit the older documentation link here.

Redirection Callback Hook

This function is used to change where the user is redirected to post certain actions. For example, you can use this to redirect a user to a specific URL post sign in / up. If you're embedding the sign in / up components in a popup and wish to disable redirection entirely, simply return null.

import SuperTokens from "supertokens-auth-react"

SuperTokens.init({
    appInfo: {
        appName: "SuperTokens",
        apiDomain: "http://localhost:3000",
        websiteDomain: "http://localhost:3000"
    },
    getRedirectionURL: async (context) => {
        if (context.action === "SUCCESS" && context.newSessionCreated) {
            // called on a successful sign in / up. Where should the user go next?
            let redirectToPath = context.redirectToPath;
            if (redirectToPath !== undefined) {
                // we are navigating back to where the user was before they authenticated
                return redirectToPath;
            }
            if (context.createdNewUser) {
                // user signed up
                return "/onboarding"
            } else {
                // user signed in
                return "/dashboard"
            }
        }
        // return undefined to let the default behaviour play out
        return undefined;
    },
    recipeList: [ /* ... */]
});
Looking for older versions of the documentation?
Which UI do you use?
Custom UI
Pre built UI