Working with the Salesforce Console Integration Toolkit

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

With Salesforce Console Integration Toolkit, you can:

  • Open a new primary tab or subtab that displays a specified URL
  • Set the title of a primary tab or a subtab
  • Return the ID of a primary tab or subtab
  • Close a specified primary tab or subtab

Before developing an Salesforce Console Integration Toolkit implementation, learn how to connect to Salesforce Console Integration Toolkit and review the best practices.

  • Connect 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 in a third-party domain.

  • Asynchronous Calls with the Salesforce Console Integration Toolkit

    The Salesforce Console Integration Toolkit lets you issue asynchronous calls. Asynchronous calls allow the client-side process to continue instead of waiting for a callback from the server. To issue an asynchronous call, you must include an additional parameter with the API call, which is referred to as a callback function. Once the result is ready, the server invokes the callback method with the result.

  • Working with Lightning Platform Canvas

    To integrate the Salesforce Console with external applications that require authentication methods, such as signed requests or OAuth 2.0 protocols, Salesforce recommends you use Lightning Platform Canvas.

  • Salesforce Console Integration Toolkit Best Practices

    Salesforce recommends that you adhere to a few best practices as you use the Salesforce Console Integration Toolkit.