Canvas Developer Guide
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
Summer '14 (API version 31.0)
Spring '14 (API version 30.0)
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Referencing the Canvas SDK
Getting Context in Your Canvas App
Alternatives to Cookies for User Tracking
Debugging in a Canvas App
Using the <select> Tag in a Canvas App
Lightning Component Code Examples
Canvas SDK
Canvas is a set of tools that enable you to integrate your apps
within Salesforce. This framework includes an SDK that you can use to
authenticate your app and retrieve data from Salesforce.
To prepare your Canvas apps for the new web browser restrictions on third-party cookies, see How Third-Party Cookie Restrictions Impact Salesforce Canvas Apps in Salesforce Help.
Important
The Canvas SDK and code examples are available on GitHub at https://github.com/forcedotcom/salesforcecanvasframeworksdk.
The Canvas SDK is versioned and matches the API version in each release. The current version is 64.0. To check the version of the SDK that you have, call the version method.
-
Referencing the Canvas SDK
-
Authentication
When you create a Canvas app, you can use the signed request authentication method or the OAuth 2.0 authentication method. -
Getting Context in Your Canvas App
-
Cross-Domain XHR
Canvas apps are loaded on a Salesforce page in an iFrame. The Canvas app has its own domain and can't make XML HTTP request (XHR) calls back to the *.salesforce.com domain. You can develop and deploy your own proxies as part of the SDK, however, Canvas provides a client-side proxy written in JavaScript. This proxy enables client-side XHR calls back to Salesforce. -
Alternatives to Cookies for User Tracking
When creating websites and applications, the HTML <iframe> element lets you display third-party content within the current page window. As modern browsers have increased privacy for end users, the iframe structure is becoming more scrutinized and restricted. Third-party applications exposed as Canvas apps are surfaced in the Salesforce user interface via an iframe. To avoid problems loading your Canvas apps in Salesforce, design applications that don’t rely on cookies, session storage, or local storage to track users. -
Resizing a Canvas App
-
Implementing Canvas App Events
-
Using Streaming API in a Canvas App
-
Debugging in a Canvas App
-
Using the <select> Tag in a Canvas App