Salesforce Console Developer Guide

Salesforce Console Developer Guide
Lightning Console API
Salesforce Classic API
When to Use the Salesforce Console Integration Toolkit
Salesforce Console Integration Toolkit Support Policy
Sample Visualforce Page Using 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 Lightning Platform Canvas
Best Practices
Methods
Other Resources
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/54.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://MyDomainName--PackageName.vf.force.com/support/console/54.0/integration.js" type="text/javascript"></script>

    If enhanced domains aren’t enabled in your org, your URL format is different. For details, see My Domain URL Formats in Salesforce Help.

    Note

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