DocumentationAPI Reference

Uploading and installing a private app

If you built an app with the Zendesk Apps framework to extend the functionality of Zendesk Support, Zendesk Sell, or Zendesk Chat, you can upload and install it so that agents can start using it. These kinds of apps are private, as opposed to the public apps available in the Zendesk Apps Marketplace.

To upload and install private Support apps, you must have the Zendesk Suite Growth plan or above, or the Support Professional plan and above.

To upload and install private Chat apps, you must have Zendesk Chat on the Zendesk Suite Growth plan or above. The Chat account must also be linked to a Zendesk Support account.

To upload and install private Sell apps, you must Zendesk Sell on the Sell Growth plan or above. The Sell account must also be linked to a Zendesk Support account.

To get a free account for testing and debugging apps, see Getting a trial or sponsored account for development.

If you haven't built an app yet:

If you're trying to build and package your app, use the Zendesk Command Line Interface (ZCLI). Refer to Using the Zendesk Command Line Interface (ZCLI).

Uploading and installing a private app in Zendesk

The file size limit of the zip file for a private app is 2 MB.

  1. In Admin Center, click the Apps and integrations icon () in the sidebar, then select Apps > Zendesk Support apps.

  2. Click Upload App.

  3. Enter a Name for the app.

  4. Click Choose file and select the zip file for your private app.

  5. Click Save.

  6. In the pop-up box that appears, click Agree and upload this App.

  7. When prompted, click Install.

    When the process is complete, your private app appears in the list of installed apps on the My Apps page.

Uploading and installing a private app in Zendesk Chat

  1. Sign in to your Support account, click on the Product Tray, and launch Chat.

  2. In the Chat dashboard, go to Settings > Account > Apps.

  3. Click Upload Private App in the right side of the page.

  4. Enter the name of your app.

  5. Click Choose File and select the zip file of your app.

  6. Click Upload to upload the app to Zendesk Chat, then again after agreeing to the risks and limitations.

  7. When prompted, click Install.

    When the process is complete, your app should appear as a private app in your list of installed apps on the page. It should also appear in the chat interface, ready for agents to use.

Uploading and installing a private app in Zendesk Sell

  1. Sign in to your Sell account, and click the Settings icon ().

  2. Select Tools > Apps.

  3. Click Upload Private App in the right side of the page.

  4. Enter the name of your app.

  5. Click Choose File and select the zip file of your app.

  6. Click Upload to upload the app to Zendesk Sell, then again after agreeing to the risks and limitations.

  7. When prompted, click Install.

    When the process is complete, your app should appear as a private app in your list of installed apps on the page. It should also appear in the Sell interface, ready for agents to use.