Die meisten Support-Teams stoßen irgendwann an eine Wand. Sie haben Tickets, Benutzer und Organisationen abgedeckt, aber was ist mit der Ausrüstung, die Kunden verwenden? Die Abonnementpläne, die sie gekauft haben? Die Bestellungen, nach denen sie fragen?
Zendesk Custom Objects lösen dieses Problem. Sie ermöglichen es Ihnen, das Datenmodell von Zendesk zu erweitern, um alles zu speichern, was für Ihr Unternehmen wichtig ist, und diese Daten dann direkt mit Support-Tickets zu verbinden.
Dieser Leitfaden behandelt alles, was Sie über die Zendesk Custom Objects API wissen müssen. Egal, ob Sie ein Entwickler sind, der Integrationen erstellt, ein Zendesk-Administrator, der Ihre Instanz erweitert, oder ein technischer Berater, der Lösungen implementiert, Sie finden praktische Beispiele und reale Muster, die Sie sofort verwenden können. Für Teams, die ihre Zendesk-Einrichtung weiter verbessern möchten, kann die eesel AI Zendesk-Integration helfen, Support-Workflows mithilfe Ihrer benutzerdefinierten Daten zu automatisieren.
Was sind Zendesk Custom Objects?
Zendesk bietet Ihnen standardmäßige Objekte: Tickets, Benutzer, Organisationen und Artikel. Diese funktionieren hervorragend für grundlegende Support-Szenarien. Aber Unternehmen sind komplexer als das.
Mit Custom Objects können Sie Ihre eigenen Datenstrukturen innerhalb von Zendesk erstellen. Stellen Sie sie sich als Datenbanktabellen vor, die Sie selbst definieren. Sie erstellen das Objekt (die Tabelle), definieren seine Felder (die Spalten) und fügen dann Datensätze (die Zeilen) hinzu.
Um effektiv mit Custom Objects zu arbeiten, müssen Sie vier Kernkonzepte verstehen:
- Custom Objects (Benutzerdefinierte Objekte) - Der Container oder die Vorlage für Ihre Daten. Dies definiert, welche Art von Dingen Sie verfolgen.
- Custom Object Fields (Benutzerdefinierte Objektfelder) - Das Schema, das definiert, welche Eigenschaften jedes Objekt hat. Ohne Felder ist Ihr Objekt nur eine leere Hülle.
- Lookup Relationship Fields (Nachschlagebeziehungsfelder) - Spezielle Felder, die Verbindungen zwischen Ihren Custom Objects und Standard-Zendesk-Objekten (oder anderen Custom Objects) herstellen.
- Custom Object Records (Benutzerdefinierte Objektdatensätze) - Einzelne Instanzen Ihrer benutzerdefinierten Daten. Wenn Ihr Objekt "Software" ist, ist jeder Datensatz eine bestimmte Software.
Zu den gängigen Anwendungsfällen gehören die Verfolgung von Hardware-Assets (Laptops, Drucker), die Verwaltung von Softwarelizenzen, die Verknüpfung von E-Commerce-Bestellungen mit Support-Tickets oder die Speicherung von Abonnementdaten. Jedes Szenario, in dem Sie während Support-Interaktionen auf unternehmensspezifische Daten verweisen müssen, ist ein Kandidat für Custom Objects. Die Zendesk-Entwicklerdokumentation bietet detaillierte Anleitungen zur Implementierung dieser Anwendungsfälle.
Neue API vs. Legacy API: Was Sie wissen müssen
Hier ist etwas Entscheidendes, das viele Entwickler verwirrt: Zendesk hat zwei völlig separate Custom Objects APIs. Sie sind nicht kompatibel. Daten, die mit der einen erstellt wurden, können von der anderen nicht abgerufen werden.
Die New Custom Objects API (Neue Custom Objects API)
Die moderne API verwendet den Endpunkt /api/v2/custom_objects und ist tief in den Zendesk Agent Workspace integriert. Datensätze werden nativ in der Benutzeroberfläche angezeigt, Nachschlagefelder funktionieren in Ticketformularen und die gesamte Erfahrung fühlt sich wie eine native Zendesk-Funktion an. In der offiziellen Dokumentation erfahren Sie mehr über die ersten Schritte mit Custom Objects.
Dies ist die API, die Sie für alle neuen Projekte verwenden sollten.
Die Legacy Custom Objects API (Legacy Custom Objects API)
Die ältere API verwendet /api/sunshine/ und war Zendesks erster Versuch mit benutzerdefinierten Daten. Sie funktioniert, fühlt sich aber eher angeflanscht als integriert an. Die Legacy Custom Objects API-Dokumentation bezeichnet dies als "Legacy Custom Objects API" und sie wird hauptsächlich für bestehende Implementierungen gepflegt.
Wenn Sie eine ältere Integration pflegen, benötigen Sie möglicherweise diese API. Andernfalls bleiben Sie bei der neuen.
Welche sollten Sie verwenden?
Sofern Sie keinen bestimmten Grund haben, die Legacy API zu verwenden (z. B. die Wartung von vorhandenem Code), wählen Sie immer die New Custom Objects API. Sie ist besser dokumentiert, besser integriert und Zendesk investiert hier in zukünftige Entwicklungsarbeit.
Erste Schritte: Voraussetzungen und Einrichtung
Bevor Sie mit API-Aufrufen beginnen können, benötigen Sie ein paar Dinge.
Erforderlicher Zendesk-Plan
Custom Objects sind nicht in allen Plänen verfügbar. Laut Zendesks Plandokumentation benötigen Sie einen der folgenden Pläne:
- Support Enterprise
- Jeden Zendesk Suite-Plan (Team, Growth, Professional, Enterprise oder Enterprise Plus)
Die Planstufe wirkt sich darauf aus, wie viele Custom Objects Sie erstellen können. Überprüfen Sie daher den Abschnitt "Limits" weiter unten in diesem Leitfaden.
Aktivieren Sie Custom Objects im Admin Center
Ein Administrator muss die Funktion aktivieren, bevor Sie sie verwenden können.
- Gehen Sie zum Admin Center
- Klicken Sie in der Seitenleiste auf Objekte und Regeln
- Wählen Sie Custom Objects > Objekte
- Klicken Sie auf Loslegen
Wenn Ihr Konto zuvor Legacy Custom Objects verwendet hat, sehen Sie ein Banner, das Ihnen anbietet, die neue Erfahrung auszuprobieren. Klicken Sie auf Ausprobieren, um die moderne API zu aktivieren.
Erstellen Sie ein API-Token
Alle API-Anfragen verwenden die Basic Authentication mit einem API-Token. Die Zendesk API-Dokumentation erklärt, wie Sie eines erstellen:
- Gehen Sie im Admin Center zu Apps und Integrationen > APIs > Zendesk API
- Klicken Sie auf die Registerkarte Einstellungen
- Aktivieren Sie Token-Zugriff, falls er noch nicht aktiviert ist
- Klicken Sie auf die Schaltfläche +, um ein neues Token hinzuzufügen
- Geben Sie ihm einen aussagekräftigen Namen wie "Custom Objects Integration"
- Kopieren Sie das Token sofort (Zendesk zeigt es nicht noch einmal an)
Authentifizierungsformat
Jede API-Anfrage benötigt einen Authorization-Header mit Ihrer E-Mail-Adresse und Ihrem Token:
Authorization: Basic {base64({email_address}/token:{api_token})}
Wenn Ihre E-Mail-Adresse beispielsweise admin@company.com und Ihr Token abc123xyz lautet, würden Sie admin@company.com/token:abc123xyz Base64-kodieren und dies in den Header aufnehmen.
Arbeiten mit der Custom Objects API
Lassen Sie uns nun die Kernoperationen durchgehen, die Sie am häufigsten verwenden werden.
Erstellen von Custom Objects
Um ein Custom Object zu erstellen, senden Sie eine POST-Anfrage an /api/v2/custom_objects mit drei erforderlichen Feldern:
- key (Schlüssel) - Ein eindeutiger Bezeichner für das Objekt (kann später nicht mehr geändert werden)
- title (Titel) - Der Singular-Anzeigename (z. B. "Software")
- title_pluralized (Titel im Plural) - Der Plural-Anzeigename (z. B. "Software")
Hier ist ein cURL-Beispiel:
curl --request POST https://{subdomain}.zendesk.com/api/v2/custom_objects \
--header "Content-Type: application/json" \
-u {email_address}/token:{api_token} \
--data-raw '{
"custom_object": {
"key": "software",
"title": "Software",
"title_pluralized": "Software"
}
}'
Optionale Felder sind:
- description (Beschreibung) - Was dieses Objekt darstellt
- allows_attachments (Erlaubt Anhänge) - Ob Datensätze Dateianhänge haben können
- include_in_list_view (In Listenansicht einschließen) - Ob Agenten dieses Objekt auf der Seite "Custom Objects Records" sehen
Definieren von Custom Object Fields
Ein Objekt ohne Felder ist nur ein leerer Container. Sie definieren das Schema mithilfe der Custom Object Fields API. Die offizielle Dokumentation zum Erstellen von Custom Objects bietet zusätzliche Anleitungen zur Feldkonfiguration:
curl --request POST https://{subdomain}.zendesk.com/api/v2/custom_objects/software/fields \
--header "Content-Type: application/json" \
-u {email_address}/token:{api_token} \
--data-raw '{
"custom_object_field": {
"key": "version",
"title": "Version",
"type": "text"
}
}'
Verfügbare Feldtypen sind Text, Textarea, Checkbox, Datum, Integer, Decimal, Regexp, Dropdown, Multiselect und Lookup. Weitere Informationen zu den einzelnen Feldtypen finden Sie in der Custom Object Fields API-Referenz.
Lookup-Felder sind besonders leistungsstark. Sie erstellen Beziehungen zwischen Objekten. Um Ihr Software-Objekt mit Tickets zu verknüpfen, erstellen Sie ein Lookup-Feld für Tickets, das auf Software verweist:
curl https://{subdomain}.zendesk.com/api/v2/ticket_fields.json \
-H "Content-Type: application/json" -X POST \
-u {email_address}/token:{api_token} \
--data-raw '{
"ticket_field": {
"type": "lookup",
"title": "Betroffene Software",
"relationship_target_type": "zen:custom_object:software"
}
}'
Verwalten von Custom Object Records
Sobald Ihr Objekt und Ihre Felder eingerichtet sind, können Sie Datensätze erstellen.
import requests
from requests.auth import HTTPBasicAuth
url = "https://{subdomain}.zendesk.com/api/v2/custom_objects/software/records"
payload = {
"custom_object_record": {
"name": "Zendesk Support",
"custom_object_fields": {
"version": "2024.1",
"license_type": "Enterprise"
}
}
}
headers = {"Content-Type": "application/json"}
auth = HTTPBasicAuth(f'{email_address}/token', api_token)
response = requests.request("POST", url, auth=auth, headers=headers, json=payload)
Die API unterstützt Cursor-basierte Paginierung für die Auflistung von Datensätzen, was für große Datensätze effizienter ist als die Offset-Paginierung. Verwenden Sie die Parameter page[after] und page[size], um durch die Ergebnisse zu navigieren. Vollständige Details zur Paginierung finden Sie in der Custom Object Records API-Referenz.
Planlimits und Best Practices
Das Verständnis der Limits hilft Ihnen, von Anfang an innerhalb der Einschränkungen zu entwerfen.
Custom Object Limits nach Plan
| Plan | Custom Objects Limit | Lookup-Felder pro Objekt |
|---|---|---|
| Suite Team | 3 | 5 |
| Suite Growth | 5 | 5 |
| Support Enterprise | 30 | 10 |
| Suite Professional | 30 | 10 |
| Suite Enterprise | 50 | 10 |
| Suite Enterprise Plus | 50 | 10 |
Andere wichtige Limits
- Maximal 100 Felder pro Custom Object (Standardfelder zählen nicht)
- Maximal 32 KB pro Datensatz
- Maximal 50 Millionen Datensätze pro Konto
- 100 Datensätze pro Seite bei der Auflistung über die API
Best Practices für die Datenmodellierung
Planen Sie Ihre Objektbeziehungen, bevor Sie mit dem Bau beginnen. Das spätere Ändern von Schlüsseln oder grundlegenden Strukturen erfordert das Neuerstellen von Objekten und das Migrieren von Daten.
Verwenden Sie das Feld external_id für Datensätze, wenn Sie mit externen Systemen synchronisieren. Auf diese Weise können Sie auf Datensätze anhand Ihrer eigenen Kennungen und nicht anhand der internen IDs von Zendesk verweisen.
Verwenden Sie zur Leistungssteigerung die Cursor-basierte Paginierung, wenn Sie große Datensatzmengen durchlaufen. Die Offset-Paginierung wird langsamer, je tiefer Sie in die Ergebnisse blättern. Weitere Optimierungstipps finden Sie in der Zendesk API-Dokumentation zur Paginierung.
Integrieren von Custom Objects in Ihren Workflow
Die wahre Stärke von Custom Objects liegt in der Art und Weise, wie sie sich in den Rest von Zendesk integrieren.
Ticketformulare und Agent Workspace
Wenn Sie Ticketformularen Lookup-Felder hinzufügen, können Agenten Custom Object Records direkt beim Anzeigen von Tickets suchen und auswählen. Die Daten des ausgewählten Datensatzes werden in der Ticket-Seitenleiste angezeigt, sodass Agenten den vollständigen Kontext erhalten, ohne den Kontext wechseln zu müssen. Anweisungen zur Einrichtung finden Sie im Zendesk-Leitfaden zu den ersten Schritten mit Custom Objects.
Zendesk Apps Framework
Sie können Seitenleisten-Apps erstellen, die Custom Object-Daten im Agent Workspace anzeigen. Dies ist nützlich, wenn Sie berechnete Daten, zugehörige Datensätze aus externen Systemen oder benutzerdefinierte Visualisierungen anzeigen müssen, die über das hinausgehen, was Lookup-Felder bieten.
Auslöser und Automatisierung
Custom Objects funktionieren mit Zendesk-Auslösern, sodass Sie basierend auf benutzerdefinierten Daten automatisieren können. Sie könnten beispielsweise Tickets zu abgelaufenen Lizenzen automatisch an ein Verlängerungsteam weiterleiten oder Probleme eskalieren, die VIP-Kunden betreffen, basierend auf Daten in einem Custom Object.
Integration externer Systeme
Die API ermöglicht die bidirektionale Synchronisierung mit externen Systemen. Sie können Produktdaten aus Ihrer E-Commerce-Plattform synchronisieren, Asset-Informationen aus Ihrem IT-Asset-Management-System abrufen oder Support-Erkenntnisse zurück in Ihr CRM übertragen.
Verwenden von eesel AI mit Zendesk Custom Data
Sobald Sie Custom Objects haben, in denen Ihre Geschäftsdaten gespeichert sind, können Sie diese Informationen in Ihren Support-Abläufen einsetzen. Bei eesel AI haben wir unsere Plattform so aufgebaut, dass sie nahtlos mit Zendesk-Daten, einschließlich Custom Objects, zusammenarbeitet.
Unsere KI-Agenten können beim Beantworten von Tickets auf Custom Object Records verweisen. Wenn ein Kunde nach seiner Softwarelizenz fragt, kann die KI den Lizenzdatensatz nachschlagen, Ablaufdaten überprüfen und genaue Informationen bereitstellen, ohne dass ein menschliches Eingreifen erforderlich ist.
Wir verwenden auch Custom Object-Beziehungen, um Interaktionen zu personalisieren. Wenn die KI weiß, welche Produkte ein Kunde verwendet (aus Ihren Custom Objects), kann sie Antworten mit relevantem Kontext anpassen und geeignete Lösungen vorschlagen.
Wenn Sie in Custom Objects investieren, um Ihre Geschäftsdaten zu modellieren, sollten Sie überlegen, wie KI diese Investition nutzen kann. Die Kombination aus strukturierten Custom Data und intelligenter Automatisierung schafft Support-Erlebnisse, die sich wirklich hilfreich und nicht generisch anfühlen. Sie können eesel AI kostenlos ausprobieren und sehen, wie es mit Ihrer Zendesk-Einrichtung funktioniert.
Beginnen Sie noch heute mit dem Aufbau mit Zendesk Custom Objects
Die Zendesk Custom Objects API bietet Ihnen die Tools, um Ihre einzigartigen Geschäftsdaten zu modellieren und direkt in Ihren Support-Workflow zu integrieren. Sie haben die Kernkonzepte, den Unterschied zwischen den API-Versionen, die Authentifizierung und die wichtigsten Operationen zum Erstellen von Objekten, Definieren von Feldern und Verwalten von Datensätzen kennengelernt.
Ihre nächsten Schritte hängen von Ihren Zielen ab. Wenn Sie eine Integration erstellen, beginnen Sie mit einem kleinen Proof of Concept, vielleicht einem Custom Object mit ein paar Feldern. Testen Sie die CRUD-Operationen und erweitern Sie sie dann auf Beziehungen und Verbindungen zu externen Systemen.
Wenn Sie ein Zendesk-Administrator sind, arbeiten Sie mit Ihrem Team zusammen, um festzustellen, welche Geschäftsdaten die Support-Interaktionen am meisten verbessern würden. Die besten Custom Object-Implementierungen lösen reale Probleme, mit denen Agenten täglich konfrontiert sind.
Und wenn Sie mehr Wert aus Ihrer Zendesk-Investition ziehen möchten, erkunden Sie, wie KI Ihre Custom Data für intelligenteren, personalisierteren Support nutzen kann. Die Kombination aus strukturierten Daten und intelligenter Automatisierung ist die Richtung, in die sich der moderne Support entwickelt. Buchen Sie eine Demo, um zu sehen, wie eesel AI mit Ihren Zendesk Custom Objects funktioniert.
Häufig gestellte Fragen
Diesen Beitrag teilen
Article by
Stevia Putri
Stevia Putri is a marketing generalist at eesel AI, where she helps turn powerful AI tools into stories that resonate. She’s driven by curiosity, clarity, and the human side of technology.
