Jump to Content
Webex Engage
HomeGuidesAPI ReferenceChangelog
Webex Engage
API Reference
HomeGuidesAPI ReferenceChangelog

Getting Started

  • Introduction

REST API v3.1

  • Obtaining access to APIs
  • Base URLs - Subdomains
  • Supported Resources
  • Authentication
  • Rate Limits

Authentication

  • /authorizeget

Teams Endpoints

  • /teamsget
  • /teams/:teamidget

Chats Endpoints

  • /chatsget
  • /chats/:chat_idget
  • /chatspost
  • /chats/:chat_id/messagespost
  • /chats/searchpost
  • /chats/:chat_idpatch
  • /chats/:chatid/triggersput
  • Transfer API - Private Beta

Users Endpoints

  • /usersget
  • /users/:useridget
  • /userspost
  • /users/searchpost
  • /users/:user_idpatch

Livechat JS SDK Reference

  • Introduction
  • imichatwidget.on("imichat-widget:ready", func(){})
  • imichatwidget.show();
  • imichatwidget.init(data, func() { });
  • imichatwidget.update(data, func() { });
  • imichatwidget.maximizeWindow();
  • imichatwidget.minimizeWindow();
  • imichatwidget.hasInitiatedChat();
  • imichatwidget.hide();

Virtual Agent Framework

  • Introduction
  • How to get started?
  • Events and Payloads
    • chat.assigned
    • message.received
    • chat.closed
  • Retry Mechanism
Powered by 

Introduction

This section explains the various JS SDK methods that Webex Engage's Livechat widget exposes for developers to control its behaviour as needed.

If you have any suggestions/requests for any new methods or callback functions, please write to [email protected]