Retrieve information about the current platform

Parameters

None

Returns

Promise<Platform>
A Promise that resolves to the currently configured Platform.

The Platform is the currently configured application, as set up with the domain when initializing xkit.js (or including from an Xkit subdomain). All of the information returned from this call can be configured in the Xkit Developer Portal.

This information can be retrieved whether or not the user has a currently active session.

const platform = await xkit.getPlatform()

console.log(platform)

// {
//   name: "MyApp",
//   slug: "my-app",
//   website: "https://myapp.com",
//   login_redirect_url: "https://myapp.com/login"
// }