JavaScript API

Every call has the same shape: CorplandDesk("command", ...arguments). Calls made before the loader arrives are queued and run in order.

CommandsCopy Anchor Link

initCopy Anchor Link

Starts the widget. Call it once.

CorplandDesk("init", {
  key: "pk_live_...",
  identity: { externalId: "user_123", name: "Ama Mensah", email: "ama@example.com", userHash: "..." },
  hideLauncher: false,
  launcherLabel: "Help",
});

identifyCopy Anchor Link

Tells Desk who the visitor is. With a valid userHash the contact is verified and sees their own history on any device. Without one, the visitor stays anonymous.

CorplandDesk("identify", {
  externalId: "user_123",
  name: "Ama Mensah",
  email: "ama@example.com",
  phone: "+233200000000",
  avatar: "https://example.com/ama.png",
  userHash: "<hex HMAC from your server>",
  attributes: { plan: "pro", company: "Kente Labs" },
});

Attributes show beside the conversation in the dashboard. Keys are strings; values are strings, numbers, booleans or null.

setAttributesCopy Anchor Link

Adds or changes attributes for the current visitor without identifying them again.

CorplandDesk("setAttributes", { plan: "business", seats: 12 });

trackCopy Anchor Link

Records an event on the contact's timeline. Useful for knowing what someone did right before they wrote in.

CorplandDesk("track", "export_failed", { format: "mp4" });

open, close, toggleCopy Anchor Link

CorplandDesk("open");
CorplandDesk("close");
CorplandDesk("toggle");

openChat, newMessageCopy Anchor Link

openChat opens the chat tab on the latest conversation. newMessage starts a new conversation, optionally with text already typed.

CorplandDesk("openChat");
CorplandDesk("newMessage", "Hi, I need help with billing");

openFeedbackCopy Anchor Link

Opens the feedback tab: the idea board, voting and a rating.

reportBugCopy Anchor Link

Opens the bug report form. Desk attaches the page address, browser, screen size and the last 20 console errors automatically. The visitor can add a screenshot.

CorplandDesk("reportBug", { title: "Checkout button does nothing", attributes: { cartId: "c_42" } });

openTicket, openHelpCopy Anchor Link

openTicket opens the support request form. openHelp opens the list of the visitor's own requests and their status. The list only shows for verified visitors.

showLauncher, hideLauncherCopy Anchor Link

Show or hide the floating button without closing an open widget.

getUnreadCopy Anchor Link

Returns the unread count, or passes it to a callback.

CorplandDesk("getUnread", (count) => console.log(count));

logout and shutdownCopy Anchor Link

Forgets the visitor on this browser and closes the widget. Call it when your user signs out.

CorplandDesk("logout");

EventsCopy Anchor Link

Listen with on and stop with off.

const onMessage = (event) => console.log(event);
CorplandDesk("on", "message", onMessage);
CorplandDesk("off", "message", onMessage);

Single page appsCopy Anchor Link

While the widget is connected it checks the address every two seconds and tells your team when the visitor moves to another page. You do not need to call anything on navigation.