Seitenleisten-Apps | Entwickler

Zur besseren Verständlichkeit übersetzt. Code, Feldnamen und die API-Referenz bleiben auf Englisch. Englische Fassung

Seitenleisten-Apps zeigen Ihre eigenen Werkzeuge neben dem Ticket: Bestellabfragen, CRM-Datensätze, interne Aktionen. ChaosDesk führt Apps aus, die für das Zendesk App Framework (ZAF) v2 geschrieben sind, sodass viele bestehende private Apps ohne Änderungen installiert werden.

Wie Apps laufen

Jede App läuft in einem abgeschotteten iframe und spricht über den ZAF-Client mit ChaosDesk, geladen von /apps/zaf_sdk.js statt der SDK-Datei von Zendesk.
client.get, client.set, client.invoke und Ereignisse nutzen die ZAF-v2-Namen (ticket.subject, ticket.requester, currentUser und so weiter).
Orte: ticket_sidebar, user_sidebar, top_bar (ein Symbol mit Popover) und nav_bar (ein Symbol in der Leiste, das ein großes Panel öffnet).

APIs aus einer App aufrufen

client.request() mit einer relativen /api/...-URL läuft als der angemeldete Agent.
Absolute URLs laufen über einen serverseitigen Proxy, der {{setting.name}}-Platzhalter füllt, auch sichere Einstellungen, sodass Secrets nie den Browser erreichen. Der Host muss in der domainWhitelist des Manifests stehen (oder ein zusätzlicher Host sein, den der Admin erlaubt). Nur https ist erlaubt, Weiterleitungen werden nicht verfolgt, und private Netzwerkadressen werden abgelehnt, sofern der Admin sie nicht erlaubt.
Parameter vom Typ password gelten immer als sicher. Sichere Einstellungen werden verschlüsselt gespeichert.

Speicher-Hooks und Anforderungen

ticket.save-Hooks können ein Absenden mit einer Meldung blockieren. Ein Hook, der nicht innerhalb von 10 Sekunden antwortet, blockiert nicht.
Ticket-Anforderungen gelten wie bei Zendesk-Apps für Aktualisierungen aus dem Agent-Workspace; Aktualisierungen über API, E-Mail und Regeln werden nicht blockiert.

Installieren

Admins installieren und konfigurieren Apps unter Admin Center, Integrations, Apps. Rollen- und Gruppenbeschränkungen gelten beide, wenn sie gesetzt sind; beschränkte Apps sind ausgeblendet, und ihre Proxy-Aufrufe werden abgelehnt.

ChaosDesk bringt eine eingebaute Jira-App mit.