Do this with AI
Install the developer-hub-app-architect skill from Contentstack agent skills. Then ask your agent:
I want a custom field that lets editors pick products from our PIM. Recommend the UI locations, token type and hosting setup, and draft the app manifest for me to review.
New to this? Set up your AI workbench first.
Build your first Developer Hub app
A Developer Hub app is how you put your own UI inside Contentstack. It can be a custom field, a sidebar next to the entry editor, a dashboard widget, or a full page, and it ships as one web app that Contentstack loads into iframes. If you have built a Contentful app or a Shopify app before, the model will feel familiar: a manifest declares where the app shows up and what it may do, and an SDK connects your code to the host.
This guide takes you from an empty folder to an installed app that reads and writes entry data, stores configuration per installation, calls APIs without exposing tokens, and runs on a production URL. Each chapter covers one layer of the stack, so you can also jump to the one you need.
What you'll learn
How an app, its manifest and its UI locations fit together
How to scaffold an app with the csdx app:create command
How to initialize App SDK v2 and use location-specific APIs
How installation configuration and secrets are stored
How app tokens, user tokens and the proxy differ
How to host the app, subscribe to lifecycle webhooks, and go live
How the pieces fit
Contentstack concept: An app is a manifest plus hosted code. The manifest lives in Developer Hub. The code lives wherever you host it.
When an editor opens an entry that uses your custom field, Contentstack reads the installed manifest, builds the iframe URL from your hosting URL plus the location's path, and loads your app. Your code calls ContentstackAppSDK.init() and gets back an object that knows which location it is running in, which entry is open, and which installation configuration applies.
The diagram shows the two directions that matter. Configuration flows down from the manifest into each installation. Requests flow up from your app through the host, which adds credentials so your frontend never holds a token.
How the chapters fit together
Manifest and UI locations creates the app, explains the manifest, and helps you pick locations.
App SDK v2 essentials initializes the SDK and reads and writes field, entry and installation data.
OAuth and machine-to-machine apps covers app tokens, user tokens, scopes and the proxy patterns.
Hosting and going live moves the app off localhost, adds lifecycle webhooks, and walks through a go-live checklist.
Read them in order the first time. Chapter 2 assumes the scaffold from chapter 1, and chapter 4 assumes the secrets setup from chapter 3.
Key takeaways
An app is a manifest in Developer Hub plus a single-page app you host.
UI locations are iframes. The location's path is appended to your hosting URL.
The App SDK is the only channel between your code and Contentstack.
API calls go through the host, so your frontend never stores a token.
When you hit problems after launch, five Developer Hub gotchas that bite on day two covers the ones that show up most often.
Frequently asked questions
What is a Developer Hub app?
A single-page web app you host yourself or on Launch. Contentstack loads it in iframes at the UI locations you declare in the app manifest, and it talks to the host through the App SDK.
Do I need a backend to build an app?
Not for most apps. The App SDK proxies Contentstack API calls, and Advanced Settings let you call third-party APIs with secrets that never reach the browser.
Which framework should I use?
Any framework that builds a single-page app works. The official boilerplate uses React, TypeScript and Vite, and this guide follows it.
Can I keep the app private to my organization?
Yes. Every app starts private and installs right away in your own organization. Publishing to the Marketplace is a separate, optional step.