Welcome

Livechat API

Usage

Livechat API code must be inserted after the Livechat installation script and wrapped as a callback of RocketChat(); function.

You can call multiple Livechat APIs on the same page.

Methods

Set custom field

To set a custom field for a visitor, you can use the following code:

RocketChat(function() {
    this.setCustomField('fieldName1', 'Any value you want to store');
    this.setCustomField('fieldName2', 'A value set just once', false); // you can pass false as the third parameter to not overwrite an already set value
});

Set theme options

To change the online color of the Livechat widget, use the following code:

RocketChat(function() {
    this.setTheme({
        color: '#04436A', // widget title background color
        fontColor: '#FFFFFF' // widget title font color
    });
});

Assign chats to a specific department

To automatically assign a Livechat widget to a specific department (for example, to use a unique Livechat widget on more than one website), use the following code:

RocketChat(function() {
    this.setDepartment('FILL HERE DEPARTMENT NAME - case sensitive');
});

Set visitor token

To set an external token for a visitor, you can use the following code:

RocketChat(function() {
    this.setGuestToken('FHwaLnp8fzjMupSAj');
});

Set name field

To set the visitor name field, you can use the following code:

RocketChat(function() {
    this.setGuestName('visitor name');
});

Set email field

To set the visitor email field, you can use the following code:

RocketChat(function() {
    this.setGuestEmail('sample@rocket.chat');
});

Register visitor

To register the visitor without using the registration form, you can use the following code:

RocketChat(function() {
    this.registerGuest({
      token: 'FHwaLnp8fzjMupSAj', // The token field is not required. If it is not passed, a new token will be generated
      name: 'visitor name',
      email: 'sample@rocket.chat'
  });
});

Events

onChatMaximized

Fired when the chat widget is maximized.

RocketChat(function() {
    this.onChatMaximized(function() {
        // do whatever you want
        console.log('chat widget maximized');
    });
});

onChatMinimized

Fired when the chat widget is minimized.

RocketChat(function() {
    this.onChatMinimized(function() {
        // do whatever you want
        console.log('chat widget minimized');
    });
});

onChatStarted

Fired when the chat is started (the first message was sent).

RocketChat(function() {
    this.onChatStarted(function() {
        // do whatever you want
        console.log('chat started');
    });
});

onChatEnded

Fired when the chat is ended either by the agent or the visitor.

RocketChat(function() {
    this.onChatEnded(function() {
        // do whatever you want
        console.log('chat ended');
    });
});

onPrechatFormSubmit

Fired when the pre-chat form is submitted.

RocketChat(function() {
    this.onPrechatFormSubmit(function(data) {
        // data is an object containing the following fields: name, email and deparment (the department _id)

        // do whatever you want
        console.log('pre-chat form submitted');
    });
});

onOfflineFormSubmit

Fired when the offline form is submitted.

RocketChat(function() {
    this.onOfflineFormSubmit(function(data) {
        // data is an object containing the following fields: name, email and message

        // do whatever you want
        console.log('offline form submitted');
    });
});

Change Log

Version Description
0.66.0 Added setGuestToken, setGuestName, setGuestEmail and registerGuest methods.
0.53.0 Added callback events and the ability to pass a flag to setCustomField so the value passed does not get wrote if there is already an existing value.
0.36.0 Added setTheme method
0.26.0 Added setCustomField method

Table of contents