Get early access

Sidebar apps

Build apps for the ticket sidebar, user profiles, the top bar and the navigation rail with the Zendesk App Framework v2 conventions.

Sidebar apps show your own tools next to the ticket: order lookups, CRM records, internal actions. ChaosDesk runs apps written for the Zendesk App Framework (ZAF) v2, so many existing private apps install without changes.

How apps run

  • Each app runs in a sandboxed iframe and talks to ChaosDesk through the ZAF client, loaded from /apps/zaf_sdk.js in place of Zendesk’s SDK file.
  • client.get, client.set, client.invoke and events use the ZAF v2 names (ticket.subject, ticket.requester, currentUser and so on).
  • Locations: ticket_sidebar, user_sidebar, top_bar (an icon with a popover) and nav_bar (a rail icon that opens a large panel).

Calling APIs from an app

  • client.request() with a relative /api/... URL runs as the signed-in agent.
  • Absolute URLs go through a server-side proxy that fills {{setting.name}} placeholders, including secure settings, so secrets never reach the browser. The host must be on the manifest’s domainWhitelist (or an extra host the admin allows). Only https is allowed, redirects are not followed, and private network addresses are refused unless the admin allows them.
  • Parameters of type password are always treated as secure. Secure settings are encrypted at rest.

Save hooks and requirements

  • ticket.save hooks can block a submit with a message. A hook that does not answer within 10 seconds does not block.
  • Ticket requirements apply to updates from the agent workspace, as with Zendesk apps; API, email and rule updates are not blocked.

Install

Admins install and configure apps under Admin Center, Integrations, Apps. Role and group restrictions both apply when set; restricted apps are hidden and their proxy calls are refused.

A built-in Jira app ships with ChaosDesk.