Are you a developer? Check out Firebase, our new platform. Build real-time apps in minutes.

API Overview

Envolve is designed to be extremely flexible so that developers and website owners can build their own custom user experiences without worrying about any of the technical hurdles involved in real-time chat. A wide range of customizations are available, including Single Sign On, color customizations, programmatic creation of groups and chats, string customizations, a slew of behavioral options, and more.

All developer options can be accessed in one of 3 ways:

1) Our administrative backend

We provide a wide array of site-wide options through our web interface. This interface allows you to customize the colors used by Envolve, control the creation of chats, modify login behavior, create "permanent" chats, modify obscenity filter settings, and more. For more information, see the section on "Customizing Envolve".

2) Single Sign On libraries

Envolve can integrate seamlessly with your site's user accounts system. You can learn more about the capabilities of Single Sign On and download the libraries for various languages in the Single Sign On section. Currently we have libraries for:

Don't worry if your language isn't listed. We can help you build your own library

3) The envoOptions javascript object

Developers have the option of programmatically controlling Envolve by placing a special "envoOptions" javascript dictionary object in their web pages. This can be used to control the functionality of Envolve on that specific page.

Here is a sample installation of Envolve with an envoOptions variable that adds the user to the group "Developers", inserts a chat into a div on the page, customizes a couple of strings, and disables automatic translation.

<script type="text/javascript">
var envoSn=3151;
var envoOptions={groups : [{id: 'developers', name: 'Developers'}],
chats : [{id : 'embeddedchat_1', name : 'Embedded Chat', divID : 'somedivid'}],
strings : {PeopleListTitlePlural : " users on this page", PeopleListTitleSingular : " user on this page"}, enableTranslation : false};
var envProtoType = (("https:" == document.location.protocol) ? "https://" : "http://");
document.write(unescape("%3Cscript src='" + envProtoType + "' type='text/javascript'%3E%3C/script%3E"));

The majority of our developer customizations are available through this envoOptions object. It allows you to do grouping, create chats, customize strings, and set a whole range of page-specific options.


Envolve Swirl