@userlike/messenger v1.2.5-alpha.1

Official Userlike Messenger API

This is currently in alpha state and is not suggested for production use.

Please be aware that during the alpha phase, there will be breaking changes without notice.

Install

npm install @userlike/messenger@internal

Usage

import { createMessenger } from "@userlike/messenger";

async function example() {
  const result = await createMessenger({
    version: 1,
    widgetKey: "YOUR_WIDGET_SECRET",
  });

  if (result.kind === "error") throw new Error(result.error);

  const { api } = result.value;

  await api.mount();
}

API

interface Api {
  /**
   * Render the messenger.
   *
   * Messenger must not be mounted.
   */
  mount(): Promise<...>;

  /**
   * Remove the messenger.
   *
   * Messenger must be mounted.
   */
  unmount(): Promise<...>;

  /**
   * Clears contact session completely.
   */
  logout(): Promise<...>;

  /**
   * Simulate as if the contact clicked the messenger button.
   *
   * This is a no-op if it's already maximized.
   */
  maximize(): Promise<...>;

  /**
   * Set custom data.
   */
  setCustomData(
    data: Record<string, unknown>
  ): Promise<...>;

  /**
   * Set contact info.
   */
  setContactInfo(data: {
    name?: string;
    email?: string;
  }): Promise<...>;
}