Types of Apps

Apps and other resources help you extend the capabilities of our core CMS and customize its functionalities. They help you enhance the Contentstack experience by connecting to various third-party services in a simple one-click installation.

Contentstack supports two types of Apps:

  • Stack Apps - These apps can be installed for any specific stack, and the scope is limited only to that stack. This type of app can be installed by only the owners/admins of the stack or by the owners/admins of the corresponding org. The org owners/admins need to be part of the stack.
  • Organization Apps - These apps have a broader scope, and the changes are applicable throughout the organization. A good example is the SCIM app that allows automatic user provisioning for all new users of the organization. This type of app can be installed by only the owners/admins of the corresponding org.

Organization Apps

Organization Apps are the apps that are installed at the Organization level, and they utilize Organization-level permissions such as SSO.

Note: Only Organization Admins are authorized to install Organization Apps.

Step to Create an Organization App

To create/register your organization app with Contentstack, refer to the Creating an App in Developer Hub documentation.

List of UI locations in Organization Apps

UI locations help you define the UI touch points where the user can experience the App. These UI Locations enable you to customize the Contentstack experience, by customizing Contentstack's default UI and behavior.

For organization apps, there is only one UI location available.

Enable UI locations in Organization Apps

  1. Click on + Add on App configuration to add the UI Location.
  2. image7.png

  3. Add the necessary details for the app, such as its Name, Data Type, and Description; select whether it’s Signedor not; provide a valid Path; and select if Enabled or not.
  4. image3.png

  5. Click on Save button to save the changes.

List Webhook Events in Organization Apps

Webhooks provide a mechanism to send real-time information to any third-party app or service. When an event occurs in your app. Organization app only supports App events.

image4.png

Limitations of Organization App

  • Organization Apps cannot target UI locations inside individual stacks.
  • Organization Apps cannot target webhook inside individual stacks.

Stack Apps

Steps to Create a Stack App

To create/register your stack app with Contentstack, refer to the Creating an App in Developer Hub documentation.

List of UI locations in Stack Apps

UI locations help you define the UI touch points where the user can experience the App. These UI Locations enable you to customize the Contentstack experience, by customizing Contentstack's default UI and behavior.
For stack apps, six UI locations are available:

  • Custom Field
  • Dashboard
  • Asset Sidebar
  • App configuration
  • RTE
  • Sidebar
  • image2.png

Enable UI Locations in Stack Apps

  1. Click on the + Add button that appears when you hover on any UI Locations, to add the UI Location. Let’s consider that we add the Custom Field location.
  2. image1.png

  3. Add the necessary details for the app, such as its Name, Data Type, and Description; select whether it’s Signed or not; provide a valid Path; and select if Enabled or not.
  4. image5.png

  5. Once done, click on Save.

List Webhook Events in Stack Apps

Webhooks provide a mechanism to send real-time information to any third-party app or service. When an event occurs in your app. Stack app has both stack events and app events./p> image6.png

Available Webhook Events for Stack App

ModulesEvents
Entry
  • Created
  • Updated
  • Deleted
  • Published
  • Unpublished
Content Type
  • Created
  • Updated
  • Deleted
Asset
  • Created
  • Updated
  • Deleted
  • Published
  • Unpublished
Global Field
  • Created
  • Updated
  • Deleted
Release
  • Deployed

Limitations of Stack App

  • Stack Apps cannot target UI locations outside the individual stack.
  • Stack Apps cannot target webhook outside the individual stack.

Was this article helpful?

Thanks for your feedbackSmile-icon

On This Page

^