About UI Embed

Last updated: 2021-12-10 Contributors None
Edit this page

The embedded UI allows RingCentral Engage Digital to be integrated in third parties, external CRMs or other customer care products.


Enable Iframe Integration

By default, iframe integrations are not permitted. In order to use the embedded UI, you'll have to allow it. This parameter is available in the “security” advanced setting:

Integrate Iframe Component

Once enabled, you'll be able to integrate RingCentral Engage Digital into your system.

It will be done through the use of an iframe tag. The iframe's source attribute should be filled with the URL of RingCentral Engage Digital Digital page you're willing to integrate. Furthermore, you'll need to add the view parameter to the URL with the value no-header. For example, to integrate the push page into your system with a 1400*1000 iframe you'll need to add the following tag:

<iframe src="https://{your-domain}.digital.ringcentral.com/tasks?view=no-header" width="1400" height="1000"></iframe>

Events Subscription

After that you have successfully integrated RingCentral Engage Digital in an iframe you can subscribe to the events sent by it. The communication can be established through the Window web API, like this:

<script type="text/javascript">
  window.addEventListener('message', function(event) {
    var name = event.data['name']; // Type: String, hold the event name
    var data = event.data['data']; // Type: Object, hold the event data

Check out more info on events