Documentation Version
Winter '16 (API version 35.0)
  • Winter '16 (API version 35.0) 35.0
  • Summer '15 (API version 34.0) 34.0
  • Spring '15 (API version 33.0) 33.0
  • Winter '15 (API version 32.0) 32.0
  • Summer '14 (API version 31.0) 31.0
  • Spring '14 (API version 30.0) 30.0
  • Winter '14 (API version 29.0) 29.0
  • English
  • Japanese

Introducing the Salesforce Console Integration Toolkit

The Salesforce console is designed for users in fast-paced environments who need to find, update, and create records in Salesforce quickly. The Salesforce Console Integration Toolkit provides you with programmatic access to the Salesforce console so that you can extend it to meet your business needs. With the Salesforce Console Integration Toolkit, you can open and close tabs in the console to streamline a business process. 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.
To use this guide, it helps if you have a basic familiarity with:
  • JavaScript
  • Visualforce
  • Web services
  • Software development
  • The Salesforce console
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; 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
  • The Salesforce console
The Salesforce Console Integration Toolkit is a browser-based JavaScript API. It uses browsers as clients to display pages as tabs in the console. The Salesforce Console Integration Toolkit:
  • Matches the API version for any given release. For example, if the current version of SOAP API is 20.0, then there's also a version 20.0 of the Salesforce Console Integration Toolkit.
  • Supports any browser that the Salesforce console supports. For more information, see “Salesforce Console” in the Salesforce online help.


To enable the toolkit for third-party domains, add the domains to the whitelist of the Salesforce console. See “Whitelist Domains for a Salesforce Console” in the Salesforce online help.