Overview
IMPORTANT: Deprecation Warning
We are no longer approving integrations using using SDK V1, V2, or V3.
V1 and V2 are deprecated and V3 will be deprecated in 2024.
Please migrate to V4 as soon as possible: we've created a Migration Guide to help you with the transition.
Embed and initialize the SDK
- Follow the steps in the quickstart guide to embed the SDK in your application.
- After you have imported the SDK to your application, you need to call the
initialize
API first. View the full reference for that API here.
CCEverywhere
Once you have successfully initialized the SDK, a Promise will be returned containing the CCEverywhere object.
As of today, it exposes 5 methods:
createDesign()
: Full editor componenteditDesign()
: Full editor componentopenQuickAction()
: Quick actions componentclose()
: Closes the active editor modalterminate()
: Un-initializes the activeCCEverywhere
instance
Types
The types reference page contains details about objects that are shared across the SDK.