Skip to main content

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.

import EmailPassword from "supertokens-auth-react/recipe/emailpassword";

getRedirectionURL: async (context) => {
if (context.action === "RESET_PASSWORD") {
// called when the user clicked on the forgot password button
} else if (context.action === "SUCCESS") {
// 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.isNewRecipeUser && context.user.loginMethods.length === 1) {
// user signed up
return "/onboarding"
} else {
// user signed in
return "/dashboard"
// return undefined to let the default behaviour play out
return undefined;
Looking for older versions of the documentation?
Which UI do you use?
Custom UI
Pre built UI