Salesforce Console Integration Toolkit for Salesforce Classic

The Salesforce Console Integration Toolkit is a browser-based JavaScript API that provides you with programmatic access to the console in Salesforce Classic. The Salesforce Console Integration Toolkit uses browsers as clients to display pages as tabs in the console. For example, the toolkit lets you integrate third-party systems with the console, opening up an external application in the same window, in a tab.

Required Editions
Available in: Salesforce Classic (not available in all orgs)
Available in: Professional, Enterprise, Performance, Unlimited, and Developer Editions

This guide explains how to use the Salesforce Console Integration Toolkit in JavaScript to embed API calls and processes. The toolkit is available for use with third-party domains, such as www.yourdomain.com; however, the examples in this guide are in Visualforce. The functionality it describes is available to your organization if you have:

Enterprise, Unlimited, Performance, or Developer Edition with the Service Cloud
Salesforce console

The Salesforce Console Integration Toolkit supports any browser that the Salesforce console supports.

To enable the toolkit for third-party domains, add the domains to the allowlist of the Salesforce console.

Note

When to Use the Salesforce Console Integration Toolkit

The Salesforce Console Integration Toolkit helps advanced administrators and developers implement custom functionality for the Salesforce console. For example, you can use the Salesforce Console Integration Toolkit to display Visualforce pages or third-party content as tabs in the Salesforce console. The Salesforce Console Integration Toolkit is an API that uses browsers as clients to display pages in the console.
Salesforce Console Integration Toolkit Support Policy

The current release of the Salesforce Console Integration Toolkit is the only version that receives enhancements.
Change a Visualforce Page by Using the Salesforce Console Integration Toolkit

Each implementation of Salesforce Console Integration Toolkit can look different. This example shows how to change the Salesforce console user interface using the Salesforce Console Integration Toolkit.
Working with the Salesforce Console Integration Toolkit

You can use Salesforce Console Integration Toolkit to streamline a business process.
Methods for Salesforce Classic

If your org is using Salesforce Classic, use Salesforce Console Integration Toolkit methods.

See Also