Messenger Browser API Reference
All available Browser APIs for Messenger
Last Updated:What's in this article?
Messenger provides browser APIs to give organizations more flexibility to customize how they want implement Messenger.
Below is a list of browser APIs that you can leverage in your implementation of Messenger:
API | Description | Parameters |
|---|---|---|
| OvationMessenger.show() | Shows the Messenger app on the screen from a previously hidden state | None |
| OvationMessenger.hide() | Puts the Messenger app into a hidden state so it is no longer visible on the screen | None |
| OvationMessenger.toggle() | Hides or Shows Messenger App Depending on its current State | None |
| OvationMessenger.reset() | Resets the user session in the Messenger app. This can be used to start a new user session between sites, products, etc. | None |
| OvationMessenger.open() | Opens the main Messenger screen into an expanded states | None |
| OvationMessenger.close() | Minimizes the main Messenger screen so only the circle Messenger widget is showing on the screen | None |
OvationMessenger .openForm(formURL | Opens Messenger in an expanded state and navigates to a specified Form | FormURL [String] The URL of the form to open inside the messenger app Example: OvationMessenger .openForm('https://f.goboomtown.com/screens/checklist/?checklistId=GLLQ3V') |
OvationMessenger .openArcicle(ArticleURL) | Opens Messenger in an expanded state and navigates to a specified Knowledge Article | ArticleURL [String] The URL of the knowledge base article to open inside the messenger app Example: OvationMessenger .openArticle('https://help.goboomtown.com/messenger-browser-api-reference') |
OvationMessenger .identifyUser(User) | Pass a user’s identifying credentials to Messenger when it first loads to automatically authenticate the user into Messenger. You can pass Email, Phone Number, Customer Contact ID, or Customer Context External ID to match. If no matches are found, the user will not be authenticated and will be asked for their email (required), name (optional), and number (option) to begin a chat conversation. | User [Object] An object containing the information to identify. Include only one property. Example: OvationMessenger .identifyUser({ email: customer@domain.com }) |