Launching the pre-built UI

The Web SDK can be used to launch the pre-built UI.

const result = await authsignal.launch(url, {
  mode: "popup",
});

authsignal.launch(url, {
  mode: "redirect",
});

const result = await authsignal.launch(url, {
  mode: "window",
});

Parameters

string

The URL obtained on your server by tracking an action.

LaunchOptions Object

The options used when launching the pre-built UI.

Show child attributes

popup | redirect | window

How the pre-built UI should launch: popup opens it in an overlay, window opens it in a separate browser window, and redirect triggers a full page redirect. If no value is supplied, mode defaults to redirect.

Only available when mode is popup.

Hide child attributes

string

Any valid CSS value for the width property.

string

Any valid CSS value for the height property. If not set, the popup will auto-adjust to the height of the content.

boolean

Whether the popup is closable with the escape key and by clicking the backdrop.

Object

Only available when mode is window.

Hide child attributes

number

The width of the window in pixels.

number

The height of the window in pixels.

function

Called when an unexpected API error occurs in the pre-built UI. Available when mode is popup or window.

Hide child attributes

string

The error code returned by the API.

number

The HTTP status code of the failed request.

Response

When mode is set as popup or window it returns a Promise<TokenPayload> that resolves when the popup or window closes.

Hide child attributes

string

The token that can be used to verify the outcome of the user action.

For more information on launching the pre-built UI see our detailed guide.

Server

Client

Call Connect

Launching the pre-built UI

Parameters

Response

​Parameters

​Response

Parameters

Response