DocumentationAPI Reference

Introduction

This document lists the events and objects, as well as any additional properties and actions, that you can use to build apps in Zendesk Support. This API is supplemented by the Core Apps API available to all Zendesk apps.

If you're just getting started, see Building your first Support app.

Each app lives in a location in the Zendesk Support user interface. The location defines what the app can do as follows:

  • All locations share a common set of events, properties, and actions
  • Each location has additional events, properties, and actions

See the following location docs for the events, properties, and actions you can use in each location.

Ticket sidebar

Panel on the right side of the ticket. For more information, see the ticket sidebar reference.

New ticket sidebar

Panel on the right side of the new ticket page. For more information, see the new ticket sidebar reference.

Ticket editor

Toolbar on the lower side of the ticket editor. If you specify ticket_editor, the app appears as an icon in this location. Clicking the icon opens the app. For more information, see the ticket editor reference.

User sidebar

Panel on the right side of the user page. For more information, see the user sidebar reference.

Organization sidebar

Panel on the right side of the organization page. For more information, see the organization sidebar reference.

Custom object record sidebar

Panel on the right side of the custom object record page. For more information, see the custom object record sidebar reference.

Side navigation

Navigation bar on the left side of the Agent Workspace. If you specify nav_bar, the app appears as an icon in this location. Clicking the icon opens the app. For more information, see the side navigation reference.

Top navigation

Right side of the bar on the upper side of the workspace. If you specify top_bar, the app appears as an icon in this location. Clicking the icon opens the app. For more information, see the top navigation reference.

Non-UI locations

  • Background: No UI, always running in the background to receive special events.
  • Modal: Opens a specialized modal dialog.

To specify the location for your app, see Setting the app location.

Use the ZAF client in your app to listen for events, invoke actions, and access properties in each location.