SDK reference

You drive the SDK by calling the global window.ObiSDK function with a command name and a payload:

window.ObiSDK(command, payload);

Calls are queued, so it is safe to call commands before the widget finishes loading.

Commands

Merge configuration into the widget. Use it to identify the customer, change visibility, move the widget, or open the menu.

window.ObiSDK("update", {
  isActive: true,
  position: "bottom-right",
  showMenu: false,
  user: { id: "user-123", email: "user@example.com" },
});

Field	Type	Description
`isActive`	`boolean`	Show or hide the widget.
`position`	`string`	`bottom-left`, `bottom`, or `bottom-right`.
`showMenu`	`boolean`	Open Obi’s menu.
`user`	`object`	Information about the customer. See Identifying users.

Start a new session for a specific plan.

window.ObiSDK("startSession", {
  planUuid: "<uuid-of-plan-to-start>",
});

Field	Type	Description
`planUuid`	`string`	UUID of the plan to start. Required.

Stop the current session. Takes no payload.

window.ObiSDK("stopSession");

Set window.obiWidgetConfig before the loader runs to configure the widget at load time. See Widget configuration for all options.

window.obiWidgetConfig = {
  apiKey: "your-api-key",
  position: "bottom-right",
  isActive: true,
};