Methods

Iris.init(options)

Starts the widget on your page. Every option is in Iris.init.

index.html

Iris.init({ appId: "app_7Hq2xK9mPz" });

Iris.identify({ token })

Signs the contact in as one of your signed-in users. token is an identity token that your server signs. See Identify users.

app.js

Iris.identify({ token });

Iris.logout()

Signs the contact out and starts a new anonymous session. Call it when the user signs out of your product.

app.js

Iris.logout();

Iris.open()

Opens the widget. To open it from a link with no code, see Open from a link.

app.js

document.querySelector("#help").addEventListener("click", () => Iris.open());

Iris.close()

Closes the widget and moves the focus back to where it was before the widget opened.

app.js

Iris.close();

Iris.setPageContext(values)

Sets the page context: facts about where the contact is in your product, for agents and triage. Each call replaces the earlier page context. See Page context.

app.js

Iris.setPageContext({ plan: "pro", cartTotal: 42.5 });

<key>string | number | boolean | nullOptional#

Iris keeps the keys in the order you send them.

Key: up to 64 charactersString value: up to 500 characters

Example: plan: "pro"

Iris.update(options)

Changes widget options after Iris.init. See Iris.update.

app.js

Iris.update({ launcher: false });

launcherbooleanOptional#

Shows the launcher. Pass false to hide it and open the widget from your own button with data-iris-open or Iris.open(). To change it later, call Iris.update.

Default: true

Example: launcher: false

Iris.on(“unread”, listener)

Calls listener with the number of unread agent messages. See Events.

app.js

Iris.on("unread", (count) => console.log(count));