Skip to main content
Configure the widget through window.obiWidgetConfig. Set it before the loader runs, and update it later at any time with the update command.

​
Options

window.obiWidgetConfig = {
  // Required
  apiKey: "your-api-key",

  // Appearance
  position: "bottom-right", // "bottom-left" | "bottom" | "bottom-right"

  // Visibility
  isActive: true,           // show or hide the widget
};
OptionTypeDefaultDescription
apiKeystringn/aRequired. Your SDK API key.
positionstring"bottom-right"Where the widget sits. One of bottom-left, bottom, bottom-right.
isActivebooleantrueWhether the widget is shown. Set to false to start hidden.
Most apps should start with the widget hidden (isActive: false) and turn it on after login. See Controlling sessions.

​
Update at runtime

You do not have to set everything up front. Change any option later with update: 
// Move the widget and show it
window.ObiSDK("update", {
  position: "bottom-left",
  isActive: true,
});
Values you pass to update are merged into the current configuration.