The iframe-based chat widget is used by our Javascript SDK to display chat conversations but it can also be deployed standalone for brands who wish to quickly build an in-app Messaging solution via an iframe hosted in a native webview.

Basic Setup

The iframe-based widget is hosted on https://inmessage.alcmeon.com/index.html?page-id=PAGE_ID&standalone=true . This url can be used to open a stadalone chat window in any browser, provided the page-id argument is correct.

Configuration

This widget supports a the following query string arguments.


Name	Description
page-id	Mandatory. You should set it to the page_id displayed within your account configuration page.
standalone	Mandatory. Set to true.
lang	An ISO-639 language code string to specify which language should be used to display static human-readable strings. The current implementation supports fr, en, de, es, and, it. If unspecified, the SDK will defaut to the browser's language. If the browser's language is not supported, the SDK will default to en.
look-and-feel	A string which contains a unique identifier to style your chat window. This unique identifier will be communicated to you by [email protected] after your custom branding is integrated. If unspecified, the SDK will default to Alcmeon's builtin styling.
ref	A string which contains the ref attribute of non-default entry points in the bot scenario configured for this page_id. If specified, XXX.
jwt	A string which contains a JWT. If unspecified, the user session will be anonymous. If specified, the user will be associated with the unique user id and user metadata stored in this JWT. When used, this JWT should be generated server-side by following the Authentication instructions.

Mobile app Notifications

While it is possible to embed directly the iframe-based widget within a native webview in any application (or, for mobile applications built via HTML-based frameworks, with the builtin application webview), the default setup is unable to send mobile app notifications to a user's device when a customer support agent sends a reply via the Alcmeon console.

Instead, we allow brand developers to register webhooks to be notified whenever a new reply is sent to a customer by an agent: they are then responsible to send via their notification framework of choice a notification to the user's device.

These alcmeon-to-brand notifications are sent via webhooks configured for Real-time Synchronization. Choose only answer notifications otherwise you will received a notification for any event in Alcmeon whereas you need only answers. This webhook contains the action.task.message.author.inmessage_author.customer_id field set by Brand developers in the Authentication JWT: it can be used to retrieve the user's device id from the Brand developer database.