This document lists the events and objects that you can use to build apps in Zendesk Chat. This API is supplemented by the Core Apps API available to all Zendesk apps.

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

Each app lives in a location in the Zendesk Chat 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 locationsAll listed locations
backgroundNo UI, always running in the background to receive special events
chat sidebarPanel on the right side of the chat

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