La plupart des équipes de support finissent par atteindre un mur. Elles ont couvert les tickets, les utilisateurs et les organisations, mais qu'en est-il de l'équipement utilisé par les clients ? Des plans d'abonnement qu'ils ont achetés ? Des commandes dont ils parlent ?
Les objets personnalisés Zendesk résolvent ce problème. Ils vous permettent d'étendre le modèle de données de Zendesk pour stocker tout ce qui compte pour votre entreprise, puis de connecter ces données directement aux tickets de support.
Ce guide couvre tout ce que vous devez savoir sur l'API des objets personnalisés Zendesk. Que vous soyez un développeur créant des intégrations, un administrateur Zendesk étendant votre instance ou un consultant technique mettant en œuvre des solutions, vous trouverez des exemples pratiques et des modèles réels que vous pourrez utiliser immédiatement. Pour les équipes qui cherchent à améliorer davantage leur configuration Zendesk, l'intégration Zendesk d'eesel AI peut aider à automatiser les flux de travail de support en utilisant vos données personnalisées.
Que sont les objets personnalisés Zendesk ?
Zendesk vous offre des objets standard prêts à l'emploi : les tickets, les utilisateurs, les organisations et les articles. Ceux-ci fonctionnent très bien pour les scénarios de support de base. Mais les entreprises sont plus complexes que cela.
Les objets personnalisés vous permettent de créer vos propres structures de données dans Zendesk. Considérez-les comme des tables de base de données que vous définissez vous-même. Vous créez l'objet (la table), définissez ses champs (les colonnes), puis ajoutez des enregistrements (les lignes).
Pour travailler efficacement avec les objets personnalisés, vous devez comprendre quatre concepts clés :
- Objets personnalisés : le conteneur ou le modèle de vos données. Cela définit le type de chose que vous suivez.
- Champs d'objets personnalisés : le schéma qui définit les propriétés de chaque objet. Sans champs, votre objet n'est qu'une coquille vide.
- Champs de relation de recherche : des champs spéciaux qui créent des connexions entre vos objets personnalisés et les objets Zendesk standard (ou d'autres objets personnalisés).
- Enregistrements d'objets personnalisés : des instances individuelles de vos données personnalisées. Si votre objet est « Logiciel », chaque enregistrement est un logiciel spécifique.
Les cas d'utilisation courants incluent le suivi des actifs matériels (ordinateurs portables, imprimantes), la gestion des licences logicielles, la liaison des commandes de commerce électronique aux tickets de support ou le stockage des données d'abonnement. Tout scénario où vous devez référencer des données spécifiques à l'entreprise pendant les interactions de support est un candidat pour les objets personnalisés. La documentation pour développeurs Zendesk fournit des didacticiels détaillés sur la mise en œuvre de ces cas d'utilisation.
Nouvelle API vs ancienne API : Ce que vous devez savoir
Voici un élément essentiel qui fait trébucher de nombreux développeurs : Zendesk a deux API d'objets personnalisés complètement distinctes. Elles ne sont pas compatibles. Les données créées avec l'une ne peuvent pas être consultées par l'autre.
La nouvelle API des objets personnalisés
L'API moderne utilise le point de terminaison /api/v2/custom_objects et est profondément intégrée à l'espace de travail d'agent Zendesk. Les enregistrements apparaissent nativement dans l'interface, les champs de recherche fonctionnent sur les formulaires de ticket et toute l'expérience ressemble à une fonctionnalité Zendesk native. Vous pouvez en savoir plus sur la prise en main des objets personnalisés dans la documentation officielle.
C'est l'API que vous devez utiliser pour tous les nouveaux projets.
L'ancienne API des objets personnalisés
L'ancienne API utilise /api/sunshine/ et a été la première tentative de Zendesk en matière de données personnalisées. Elle fonctionne, mais elle donne l'impression d'être ajoutée plutôt qu'intégrée. La documentation de l'ancienne API des objets personnalisés la désigne comme « l'ancienne API des objets personnalisés » et elle est principalement maintenue pour les implémentations existantes.
Si vous maintenez une ancienne intégration, vous pourriez avoir besoin de cette API. Sinon, restez avec la nouvelle.
Laquelle devriez-vous utiliser ?
À moins que vous ayez une raison spécifique d'utiliser l'ancienne API (comme la maintenance du code existant), choisissez toujours la nouvelle API des objets personnalisés. Elle est mieux documentée, mieux intégrée et c'est là que Zendesk investit ses futurs efforts de développement.
Prise en main : Prérequis et configuration
Avant de pouvoir commencer à faire des appels d'API, vous aurez besoin de quelques éléments en place.
Plan Zendesk requis
Les objets personnalisés ne sont pas disponibles sur tous les plans. Selon la documentation des plans de Zendesk, vous avez besoin de l'un des éléments suivants :
- Support Enterprise
- Tout plan Zendesk Suite (Team, Growth, Professional, Enterprise ou Enterprise Plus)
Le niveau de plan affecte le nombre d'objets personnalisés que vous pouvez créer, alors consultez la section des limites plus loin dans ce guide.
Activer les objets personnalisés dans le Centre d'administration
Un administrateur doit activer la fonctionnalité avant que vous puissiez l'utiliser.
- Allez dans Centre d'administration
- Cliquez sur Objets et règles dans la barre latérale
- Sélectionnez Objets personnalisés > Objets
- Cliquez sur Commencer
Si votre compte utilisait auparavant des objets personnalisés hérités, vous verrez une bannière vous proposant d'essayer la nouvelle expérience. Cliquez sur Essayez-la pour activer l'API moderne.
Créer un jeton d'API
Toutes les requêtes d'API utilisent l'authentification de base avec un jeton d'API. La documentation de l'API Zendesk explique comment en créer un :
- Dans le Centre d'administration, allez dans Applications et intégrations > API > API Zendesk
- Cliquez sur l'onglet Paramètres
- Activez Accès au jeton s'il n'est pas déjà activé
- Cliquez sur le bouton + pour ajouter un nouveau jeton
- Donnez-lui un nom descriptif comme « Intégration des objets personnalisés »
- Copiez le jeton immédiatement (Zendesk ne le montrera plus)
Format d'authentification
Chaque requête d'API a besoin d'un en-tête d'autorisation avec votre adresse e-mail et votre jeton :
Authorization: Basic {base64({adresse_email}/token:{jeton_api})}
Par exemple, si votre adresse e-mail est admin@company.com et votre jeton est abc123xyz, vous encoderez en Base64 admin@company.com/token:abc123xyz et l'inclurez dans l'en-tête.
Travailler avec l'API des objets personnalisés
Passons maintenant en revue les opérations de base que vous utiliserez le plus souvent.
Création d'objets personnalisés
Pour créer un objet personnalisé, envoyez une requête POST à /api/v2/custom_objects avec trois champs obligatoires :
- key : un identifiant unique pour l'objet (ne peut pas être modifié ultérieurement)
- title : le nom d'affichage au singulier (par exemple, « Logiciel »)
- title_pluralized : le nom d'affichage au pluriel (par exemple, « Logiciels »)
Voici un exemple cURL :
curl --request POST https://{sous_domaine}.zendesk.com/api/v2/custom_objects \
--header "Content-Type: application/json" \
-u {adresse_email}/token:{jeton_api} \
--data-raw '{
"custom_object": {
"key": "software",
"title": "Software",
"title_pluralized": "Software"
}
}'
Les champs facultatifs incluent :
- description : ce que cet objet représente
- allows_attachments : si les enregistrements peuvent avoir des pièces jointes
- include_in_list_view : si les agents voient cet objet dans la page des enregistrements d'objets personnalisés
Définition des champs d'objets personnalisés
Un objet sans champs n'est qu'un conteneur vide. Vous définissez le schéma à l'aide de l'API des champs d'objets personnalisés. La documentation officielle sur la création d'objets personnalisés fournit des conseils supplémentaires sur la configuration des champs :
curl --request POST https://{sous_domaine}.zendesk.com/api/v2/custom_objects/software/fields \
--header "Content-Type: application/json" \
-u {adresse_email}/token:{jeton_api} \
--data-raw '{
"custom_object_field": {
"key": "version",
"title": "Version",
"type": "text"
}
}'
Les types de champs disponibles incluent le texte, la zone de texte, la case à cocher, la date, l'entier, le décimal, le regexp, la liste déroulante, la sélection multiple et la recherche. Consultez la référence de l'API des champs d'objets personnalisés pour obtenir des détails complets sur chaque type de champ.
Les champs de recherche sont particulièrement puissants. Ils créent des relations entre les objets. Pour lier votre objet Logiciel aux tickets, créez un champ de recherche sur les tickets qui pointe vers Logiciel :
curl https://{sous_domaine}.zendesk.com/api/v2/ticket_fields.json \
-H "Content-Type: application/json" -X POST \
-u {adresse_email}/token:{jeton_api} \
--data-raw '{
"ticket_field": {
"type": "lookup",
"title": "Logiciel affecté",
"relationship_target_type": "zen:custom_object:software"
}
}'
Gestion des enregistrements d'objets personnalisés
Une fois votre objet et vos champs configurés, vous pouvez créer des enregistrements.
import requests
from requests.auth import HTTPBasicAuth
url = "https://{sous_domaine}.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'{adresse_email}/token', jeton_api)
response = requests.request("POST", url, auth=auth, headers=headers, json=payload)
L'API prend en charge la pagination basée sur le curseur pour la liste des enregistrements, ce qui est plus efficace que la pagination de décalage pour les grands ensembles de données. Utilisez les paramètres page[after] et page[size] pour naviguer dans les résultats. Consultez la référence de l'API des enregistrements d'objets personnalisés pour obtenir des détails complets sur la pagination.
Limites du plan et bonnes pratiques
Comprendre les limites vous aide à concevoir dès le départ en tenant compte des contraintes.
Limites des objets personnalisés par plan
| Plan | Limite d'objets personnalisés | Champs de recherche par objet |
|---|---|---|
| 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 |
Autres limites importantes
- 100 champs maximum par objet personnalisé (les champs standard ne comptent pas)
- 32 Ko maximum par enregistrement
- 50 millions d'enregistrements maximum par compte
- 100 enregistrements par page lors de la liste via l'API
Bonnes pratiques pour la modélisation des données
Planifiez les relations de vos objets avant de commencer à construire. La modification des clés ou des structures fondamentales ultérieurement nécessite de recréer des objets et de migrer des données.
Utilisez le champ external_id pour les enregistrements lors de la synchronisation avec des systèmes externes. Cela vous permet de référencer les enregistrements par vos propres identifiants plutôt que par les ID internes de Zendesk.
Pour les performances, utilisez la pagination basée sur le curseur lors de l'itération dans de grands ensembles d'enregistrements. La pagination de décalage devient plus lente à mesure que vous avancez dans les résultats. Consultez la documentation sur la pagination de l'API Zendesk pour obtenir des conseils d'optimisation supplémentaires.
Intégration des objets personnalisés dans votre flux de travail
La véritable puissance des objets personnalisés vient de la façon dont ils s'intègrent au reste de Zendesk.
Formulaires de ticket et espace de travail de l'agent
Lorsque vous ajoutez des champs de recherche aux formulaires de ticket, les agents peuvent rechercher et sélectionner des enregistrements d'objets personnalisés directement lors de la consultation des tickets. Les données de l'enregistrement sélectionné apparaissent dans la barre latérale du ticket, ce qui donne aux agents un contexte complet sans changer de contexte. Consultez le guide de Zendesk sur la prise en main des objets personnalisés pour obtenir des instructions de configuration.
Zendesk Apps Framework
Vous pouvez créer des applications de barre latérale qui affichent les données des objets personnalisés dans l'espace de travail de l'agent. Ceci est utile lorsque vous devez afficher des données calculées, des enregistrements associés provenant de systèmes externes ou des visualisations personnalisées qui vont au-delà de ce que les champs de recherche fournissent.
Déclencheurs et automatisation
Les objets personnalisés fonctionnent avec les déclencheurs Zendesk, ce qui vous permet d'automatiser en fonction des données personnalisées. Par exemple, vous pouvez automatiquement acheminer les tickets concernant les licences expirées vers une équipe de renouvellement, ou intensifier les problèmes affectant les clients VIP en fonction des données d'un objet personnalisé.
Intégration du système externe
L'API permet une synchronisation bidirectionnelle avec les systèmes externes. Vous pouvez synchroniser les données du catalogue de produits à partir de votre plateforme de commerce électronique, extraire les informations sur les actifs de votre système de gestion des actifs informatiques ou renvoyer les informations de support à votre CRM.
Utilisation d'eesel AI avec les données personnalisées Zendesk
Une fois que vous avez des objets personnalisés stockant vos données commerciales, vous pouvez mettre ces informations au travail dans vos opérations de support. Chez eesel AI, nous avons conçu notre plateforme pour qu'elle fonctionne de manière transparente avec les données Zendesk, y compris les objets personnalisés.
Nos agents d'IA peuvent référencer les enregistrements d'objets personnalisés lors de la réponse aux tickets. Si un client pose des questions sur sa licence logicielle, l'IA peut rechercher l'enregistrement de la licence, vérifier les dates d'expiration et fournir des informations précises sans intervention humaine.
Nous utilisons également les relations d'objets personnalisés pour personnaliser les interactions. Lorsque l'IA sait quels produits un client utilise (à partir de vos objets personnalisés), elle peut adapter les réponses avec un contexte pertinent et suggérer des solutions appropriées.
Si vous investissez dans des objets personnalisés pour modéliser vos données commerciales, réfléchissez à la façon dont l'IA peut tirer parti de cet investissement. La combinaison de données personnalisées structurées et d'automatisation intelligente crée des expériences de support qui semblent vraiment utiles plutôt que génériques. Vous pouvez essayer eesel AI gratuitement et voir comment cela fonctionne avec votre configuration Zendesk.
Commencez à construire avec les objets personnalisés Zendesk dès aujourd'hui
L'API des objets personnalisés Zendesk vous donne les outils pour modéliser vos données commerciales uniques et les intégrer directement dans votre flux de travail de support. Vous avez appris les concepts de base, la différence entre les versions de l'API, comment vous authentifier et les opérations clés pour créer des objets, définir des champs et gérer des enregistrements.
Vos prochaines étapes dépendent de vos objectifs. Si vous construisez une intégration, commencez par une petite preuve de concept, peut-être un objet personnalisé avec quelques champs. Testez les opérations CRUD, puis passez aux relations et aux connexions de systèmes externes.
Si vous êtes un administrateur Zendesk, travaillez avec votre équipe pour identifier quelles données commerciales amélioreraient le plus les interactions de support. Les meilleures implémentations d'objets personnalisés résolvent les problèmes réels auxquels les agents sont confrontés quotidiennement.
Et si vous cherchez à tirer plus de valeur de votre investissement Zendesk, explorez comment l'IA peut tirer parti de vos données personnalisées pour un support plus intelligent et plus personnalisé. La combinaison de données structurées et d'automatisation intelligente est la voie que prend le support moderne. Réservez une démonstration pour voir comment eesel AI fonctionne avec vos objets personnalisés Zendesk.
Foire aux questions
Partager cet article
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.
