Introduction

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

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

Each app lives in a location in the Zendesk Sell 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.

Location Description
all locations All listed locations
lead card Panel on the right side of the Lead card
company card Panel on the right side of the Company card
person card Panel on the right side of the Person card
deal card Panel on the right side of the Deal card
top bar Right side of the bar on the upper side
background No UI. Always running in the background to receive special events

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