You do not turn the toolkit on with a single switch. You enable the Service Cloud Console app, load the toolkit script where your code runs, and, for external code, allowlist the domain so the browser permits the calls. These steps prepare a Classic console to accept toolkit customizations.
- Confirm Service Cloud and a console app
The toolkit only works against a Salesforce console in Salesforce Classic with Service Cloud, on Enterprise, Unlimited, Performance, or Developer Edition. Make sure a console app exists and the agents who need it have access.
- Include the toolkit script
In a Visualforce page, add a script tag with a relative path such as /support/console/61.0/integration.js before your own code. From a third-party domain, use the fully qualified My Domain Visualforce URL to the same file. Use a current API version.
- Allowlist any external domain
If your JavaScript runs on a site outside Salesforce, an admin must add that domain to the console allowlist of approved domains. Without it the browser blocks the cross-origin toolkit calls and nothing happens.
- Call methods with callbacks
Invoke toolkit methods such as opening a primary tab or setting a tab title, and pass a callback function to read each result. Test inside the console, not a standalone browser tab, because the methods only respond within a console session.
The /support/console/<version>/integration.js file you reference; the version segment is the toolkit API version and should be kept current.
The console setting where admins list external domains permitted to call the toolkit; required for any third-party-hosted code.
The extra argument passed to each asynchronous method; the console invokes it with a result object once the action completes.
- The toolkit is Salesforce Classic only. In Lightning Experience, use the Lightning Console JavaScript API; only toolkit methods at API version 42.0 and above bridge into Lightning, and some return a failure error message.
- Results arrive in the callback, not as a return value on the same line. Reading the result immediately after the call gives you nothing.
- Third-party code fails silently if the domain is not on the console allowlist. Check the allowlist before debugging your own JavaScript.
- Pinning the include path to an old API version is risky. Versions more than three years old may lose support after a one-year end-of-life notice.