Developer Platform
  • Home
  • Getting Started
    • General Information
    • Features Overview
    • Security
  • APPs
    • Public Apps
      • Shopify
      • Salesforce
      • Zendesk
      • Google Analytics
    • Build your App
      • Getting started
      • My Apps
      • App information
      • App Parameters
      • App Plugins
      • Add Webhooks
      • Submit your Apps
      • App security
      • Developer Policy
  • Use Cases
    • Copilots
      • Product Catalog sync through API
      • FAQ sync through API
    • Visitor experience
      • Integrating custom buttons into your site
      • Check availability before escalating to iAdvize
      • Authenticated Messaging
        • Introduction
        • Web client-side implementation
          • Authenticated Messaging overview
          • Brief timeline of the integration process
          • How to enable authenticated mode in the administration portal?
          • How to implement the customer authentication backend (token provider)?
          • How to authenticate with iAdvize in client's website?
          • How to deal with activation success or failure?
          • How to logout?
          • Compatibility with Mobile SDK
          • FAQ
        • Web backend implementation
          • Important information and recommendations
          • Signature and Encryption Detailed Process
          • Technical backend implementation
          • FAQ
      • Cross-domain Conversation Continuity
      • Customize replies with Markdown
    • Agent workspace
      • Custom App example and step-by-step tutorial
        • Get Started
        • Work with the Desk
        • Intent / Trigger
        • JWT
        • References
    • Administration
      • Users
        • SAML SSO Authentication - Implementation Guide
        • Create, update and delete users via API
        • Manage the availability of your users with the iAdvize API
        • Integrate the iAdvize conversation panel into an existing tool
    • Data & Analytics
      • Anonymize a conversation or visitor data
      • Create a custom dashboard
      • Find contact data using GraphQL
      • Retrieve conversations data
      • Retrieve messages exchanged within a conversation
  • Technologies
    • GraphQL API
      • Terminology
      • Reference
      • Authentication
      • Schema lifecycle
      • Error Management
      • Pagination
    • REST API (deprecated)
      • Statistic (deprecated)
      • Group (deprecated)
      • Call meeting (deprecated)
      • Operator (deprecated)
      • Skill (deprecated)
      • Transaction (deprecated)
      • Visitor (deprecated)
    • Webhooks
      • Reference
      • Guides
    • Desk events
      • Reference
    • Web & Mobile SDK
      • Javascript Web SDK
        • Reference
      • Javascript Callbacks
        • Reference
        • Guides
      • Mobile SDK
        • Fourme (latest)
        • Epoisses
        • Dauphin
        • Cantal
        • 🤝Support Policy
        • 🤔Frequently Asked Questions
    • Custom App
    • External Bot
      • Implementation
        • Configuration flow
        • Conversation flow
        • Conversation objects
      • Configuration
      • FAQ
      • Best practices
Powered by GitBook
On this page
  • Objective
  • Use case
  • Process
  • Prerequisite - definition of the user journey (agent)
  • Technical operation details of options 2 & 3
  • To keep in mind
  • Example
  • Go further with our desk events

Was this helpful?

  1. Use Cases
  2. Administration
  3. Users

Integrate the iAdvize conversation panel into an existing tool

PreviousManage the availability of your users with the iAdvize APINextData & Analytics

Last updated 11 months ago

Was this helpful?

Objective

Allow the iAdvize conversation panel to be opened in external tools used by our clients via an iFrame or through the automatic opening of the conversation panel in a new tab.

Use case

Automatic opening of the iAdvize conversation panel when connecting to the client tool. (for example, a CRM other than Salesforce, Zendesk or Coheris for which we already have connectors).

Process

Prerequisite - definition of the user journey (agent)

First, define “functionally” how you imagine things from a “user journey” perspective.

There are three options for users who connect to the client tool to access the iAdvize conversation:

  • Option 1: Automatic opening of the conversation panel in a new page/ tab when operators are connected to the client’s tool => solution that would allow them to automatically connect to the iAdvize conversation panel as soon as they arrive in the client’s tool (can be completed with one of the following two solutions).

  • Option 2: Open the conversation panel in a <iframe> tag in a tab / category / page of the client tool.

  • Option 3: A link/button that leads to a new page/tab.

Secondly, it is important to set whether you expect your users to sign in to iAdvize manually in addition to your other tool.

  • If so, a simple link to the iAdvize conversation panel would be enough and users will have to enter their identifiers (which will potentially be different from those of the client tool) => time-consuming solution for users

  • If not, automatically connect them using the . Save the iAdvize SSO token on the client tool side for each existing user, which you can pass as a URL parameter to access the conversation panel: this will have the effect of automatically connecting them in the iAdvize conversation panel.

Technical operation details of options 2 & 3

  • Link option: Clicking on this link will open the conversation panel in a new page or tab. This link will be integrated in the element of the page of your choice (button, text..)

https://ha.iadvize.com/admin/login?key=xxxxxxxxxxxxxxxx
 
Key = token SSO (see more info above SSO provided by iAdvize)
  • iFrame option: Very similar to the above option, you can enter the above url in the src attribute of the iframe html tag.

Ex: <iframe src="https://ha.iadvize.com/admin/login?key=xxxxxxxxxxxxxxxx"></iframe>

To keep in mind

1 - Screen resolutions

The following recommendations apply to the iFrame dimensions of the iAdvize interface:

The recommended optimal resolution:

  • Width: 1920px

  • Height: 930px

The recommended resolution:

  • Width: 1440px

  • Height: 750px

The minimum recommended resolution:

  • Width: 1280px

  • Height: 650px

2 - API call to get your SSO key

https://ha.iadvize.com/api/2/operator?key=YOUR_API_KEY&fields=sso_key

YOUR_API_KEY will be given to you by your Customer Success Manager or Technical Account Manager upon request.

Example

Go further with our desk events

This will give you all the information you need regarding the events triggered by the iAdvize desk. Using these events can really improve the integration of the iAdvize console within your tool.

SSO provided by iAdvize
article