SDK Reference

SDK v1 and v2 End of Life

Embed SDK v1 and v2 will reach end of life by the May 12th, 2025. After this date, they will no longer be supported. Please upgrade to the latest SDK version to avoid disruption.

We're only accepting new integrations using the SDK version 4. Refer to our migration guide for detailed instructions.

This is the main API for accessing all Adobe Express Embed SDK components. The initialize() method takes HostInfo and an optional ConfigParams, and returns a CCEverywhere object.

initialize()

The default method initialize() is the API used to initialize the SDK. Make sure to call it only once a page.

// after loading the SDK into the window
window.CCEverywhere.initialize(
  /* HostInfo */
  {
    clientId: YOUR_CLIENT_ID,
    appName: YOUR_PROJECT_NAME,
    appVersion: { major: 1, minor: 0 },
    platformCategory: "web",
  },
  /* ConfigParams (optional) */
  {
    locale: "en_US",
  }
);
Copied to your clipboard
// after loading the SDK into the window
window.CCEverywhere.initialize(
  /* HostInfo */
  {
    clientId: YOUR_CLIENT_ID,
    appName: YOUR_PROJECT_NAME,
    appVersion: { major: 1, minor: 0 },
    platformCategory: "web",
  },
  /* ConfigParams (optional) */
  {
    locale: "en_US",
  }
);

HostInfo

Property	Type	Description
clientId	string	Your API Key
appName	string	Name of project folder created in user's Adobe Express account
appVersion	{ major: number, minor: number, patch?: number}	Your app version
platformCategory	'web'	Specify host app platform