The Groove support widget makes it easy to add your knowledge base or contact form to your website.

For most uses, you can simply follow the instructions for installing your widget, and everything will work as intended.

However, in some cases you may want to have the widget open when clicking a different element on your site, or automatically open up the widget based on the users actions. 

Alternatively, you may want to update or pass through additional information for the contact which is displayed in the right hand panel of your Groove Inbox or your custom profile when a customer contacts you through the widget contact form.

Controlling the widget

It's extremely simple to control the widget programmatically. It is important to remember however, that the widget script will need to be included on all the pages which you will want the widget available on.

If you don't want the Open or Close badge to display for the widget, you can hide it by selecting the "Do not show badge" option under Display, which can be found by going to your widget settings and then navigating to Customize in the left side navigation.

Here are the functions:

// Open the widget
groove.widget.open()

// Close the widget
groove.widget.close()

// Toggle the widget's visibility
groove.widget.toggle()

// Destroy's the instance of the widget
groove.widget.destroy()

 

Passing through information to the Custom Profile or Custom Fields

Whether you using Groove's custom fields or the custom profile, you can update the information through the Javascript API of the widget by following the guides below: