Launching the pre-built UI

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

authsignal.launch(url, options);

Parameters

url

string

The URL obtained on your server by tracking an action.

options

LaunchOptions Object

The options used when launching the pre-built UI.

Show child attributes

mode

popup | redirect

How the pre-built UI should launch: popup will cause it to open in a overlay, whilst redirect will trigger a full page redirect. If no value is supplied, mode defaults to redirect.

Hide child attributes

width

string

Any valid CSS value for the width property.

height

string

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

isClosable

boolean

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

Response

Promise<TokenPayload>

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

Hide child attributes

token

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

Launching the pre-built UI

Parameters

Response

Server

Client

​Parameters

​Response

Parameters

Response