About Contentstack App SDK

The Contentstack App SDK allows you to build custom applications that interact directly with Contentstack’s content management interface. Developed in TypeScript, it provides type-safe methods to access content data, manage UI extensions, and interact with Contentstack’s core APIs.

Using the Contentstack App SDK, you can:

• Create custom UI extensions that run within Contentstack.
• Integrate third-party services into Contentstack workflows.
• Access entry and field data in supported UI locations within the Contentstack interface.
• Share configuration data across app locations.
• Build apps at the stack or organization level.

The SDK is designed for apps distributed through the Contentstack or managed through the Developer Hub.

The Contentstack App SDK supports the following UI locations:

• Custom Field: Build custom fields for content types
• Dashboard: Create widgets for the stack dashboard
• Asset Sidebar: Extend asset management workflows
• Sidebar: Add contextual tools to the entry editor
• JSON RTE: Create plugins for the Rich Text Editor
• Field Modifier: Modify entry field behavior dynamically
• App Configuration: Manage app-wide settings
• Full Page: Render full-page applications inside a stack
• Global Full Page: Build cross-stack apps at the organization level
• Content Type Sidebar: Add schema tools to the Content Type builder

Each UI location provides access to specific context objects and APIs through the SDK.

The App SDK initializes when your app loads inside Contentstack. After initialization, the SDK detects the active UI location and exposes only the relevant APIs for that location.

This approach ensures:

• Location-specific access control.
• Predictable app behavior.
• Clear separation of concerns across UI locations.

Use the Contentstack App SDK when you want to:

• Extend the Contentstack UI.
• Integrate external tools within Contentstack content workflows.
• Build apps for the Contentstack Marketplace or the Developer Hub.
• Customize content editing, asset handling, or publishing experiences.