Create content

When submitting your app, include the following in your en.json file:

  • Name (name)
  • Short description (short_description)
  • Long description (long_description)
  • Installation instructions (installation_instructions)

This content will be displayed on the Zendesk App Marketplace (see example).

Example en.json:

{
  "app": {
    "name": "App name",
    "short_description": "Quickly see your products",
    "long_description": "Access bookmarked tickets from our iPad & iPhone app",
    "installation_instructions": "Simply click the install button"
  }
}

If you are building a multi-product app, you can specify separate marketplace content per product.

Note: Currently, only English content is shown in the Marketplace.

Short description

A very quick, concise summary of your app. Must be no more than 80 characters long, including spaces.

Displays Shopify customer and order details

The short description is displayed when listing apps in the Zendesk Support user interface.

Long description

A longer, more in-depth description of your app. You must use Markdown for formatting. Use the '\n' character to specify new lines. The maximum length is 3,000 characters, including spaces. Make sure you provide a description of your company and what your app does. Typically, a company boilerplate followed by what the integration does works well here. Include a call to action, like "Sign up for a free trial here" or "Get started" if you offer a free trial.

Mailchimp helps you design email newsletters, share them on social networks, integrate with services you already use, and track your results. It's like your own personal publishing platform.

  • Powerful
  • Easy to use
  • Integrates with Google Analytics, Docs & Contacts

We make it easy to send email newsletters to your customers, manage your subscriber lists, track campaign performance, and sync your email marketing with social networks like Twitter, Facebook, and Linkedin.

Installation instructions

Instructions telling the user how to install the app. You should assume that users have little technical knowledge and may never have installed an app before. The maximum length is 3,000 characters, including spaces.

You must use Markdown for formatting. Use the '\n' character to specify new lines. Be generous with numbered steps, images, and any other rich text content. If you decide to use images, you'll need to host them on a secure image server.


Up next: Set up a paid app