Salesforce Console Integration Toolkit Developer's Guide

Introducing the Salesforce Console Integration Toolkit
Working with the Salesforce Console Integration Toolkit
Connecting to the Toolkit
Asynchronous Calls with the Salesforce Console Integration Toolkit
Working with Force.com Canvas
Best Practices
Methods for Primary Tabs and Subtabs
Methods for Navigation Tabs
Methods for Computer-Telephony Integration (CTI)
Methods for Application-Level Custom Console Components
Methods for Push Notifications
Methods for Console Events
Methods for Live Agent
Methods for Omni-Channel
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Connecting to the Toolkit

The first portion of any JavaScript code that uses the Salesforce Console Integration Toolkit must make the toolkit available to the JavaScript code. The syntax for this is different depending on whether you are embedding JavaScript in a Visualforce page, or a third-party domain.
  • For Visualforce pages or any source other than a custom onclick JavaScript button, specify a <script> tag that points to the toolkit file:
    1<apex:page>
2          <script src="/support/console/34.0/integration.js" type="text/javascript"></script>
3     ...
4</apex:page>

    For Visualforce, a relative path is sufficient to include integration.js, and is recommended.

  • For a third-party domain:
    1<script src="https://c.na1.visual.force.com/support/console/34.0/integration.js" type="text/javascript"></script>

    For third-party domains, it is necessary to specify an absolute URL to integration.js to use the toolkit. The default instance at which you can access the toolkit library is: c.na1.visual.force.com/support/console/34.0/integration.js. We recommend that you use the default instance when the organization’s instance cannot be determined.

The version of the Salesforce Console Integration Toolkit is in the URL.