Compute the destination after a custom sign-in flow
Custom authentication UI
Clerk · Pipe
afterSignInUrl
buildAfterSignInUrl() returns the Clerk-configured full URL or path for navigation after successful sign-in or sign-up. The legacy afterSignInUrl setting is deprecated in favor of current redirect configuration options.
How it works
buildAfterSignInUrl() reads the Clerk instance configuration and produces the full URL or path intended for navigation after a successful sign-in or sign-up. The optional params object can provide URL search parameters when constructing the result.
Syntax
function buildAfterSignInUrl(params?: { params?: URLSearchParams }): stringParameters
| Name | Type | Description |
|---|---|---|
params | { params?: URLSearchParams } | Optional options object; its params property supplies URL search parameters used when building the destination. |
Returns
A string containing the configured full URL or path for after-sign-in navigation.
Key points
- The configured value can be either an absolute URL or an application-relative path used after authentication succeeds.
- Calling the builder reads the post-sign-in destination from the current Clerk instance.
- The method accepts optional URL search parameters and always returns a string.
- Clerk also exposes a redirect operation that uses the configured post-sign-in destination directly.
Common mistakes
- The older
afterSignInUrlconfiguration is deprecated in the current stable guidance; use the sign-in fallback or force-redirect configuration instead. - Fallback behavior applies only when the incoming URL does not already contain a
redirect_urlquery parameter.
Example: Navigate to the configured post-sign-in URL
const destination = Clerk.buildAfterSignInUrl();
window.location.assign(destination);Builds the configured destination and navigates the browser there after sign-in.
When to use it
Construct a post-authentication URL with search parameters
Redirect handling
Replace legacy post-sign-in configuration with current redirect settings
Migration
Interview questions
QWhat does buildAfterSignInUrl() do?
It returns the configured full URL or path used after a successful sign-in or sign-up. The method signature accepts an optional object containing URL search parameters.
Follow-up: How would you preserve an incoming redirect? Use the redirect-aware sign-in configuration and let the incoming redirect_url take precedence when the fallback behavior is selected.
QWhat is the method signature and return type?
Its signature is function buildAfterSignInUrl(params?: { params?: URLSearchParams }): string. It returns a string suitable for navigation.
Follow-up: Why might the result be a path rather than an absolute URL? Clerk documents the setting as accepting either a full URL or a path.
QIs afterSignInUrl still the recommended configuration?
The legacy afterSignInUrl prop and corresponding environment variable are deprecated. Current configuration should use the sign-in fallback or force-redirect alternatives.
Follow-up: When is fallback preferable? Choose fallback when an existing redirect should be honored and the configured destination should apply only when no redirect is present.
Related
buildSignInUrlredirectToAfterSignInsignInFallbackRedirectUrlsignInForceRedirectUrlredirectUrl