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.
|all locations||All listed locations|
|ticket sidebar||Panel on the right side of the ticket|
|new ticket sidebar||Panel on the right side of the new ticket|
|ticket editor||Toolbar on the lower side of the rich-text ticket editor|
|user sidebar||Panel on the right side of the user page|
|organization sidebar||Panel on the right side of the organization page|
|nav bar||Navigation bar on the left side|
|top bar||Right side of the bar on the upper side|
|background||No UI, always running in the background to receive special events|
To specify the location for your app, see Setting the app location.
If you specify
ticket_editor, the app appears as an icon in the location. Clicking the icon opens the app.
Use the ZAF client in your app to listen for events, invoke actions, and access properties in each location.