La mayoría de los equipos de soporte eventualmente se topan con una pared. Tienen cubiertos los tickets, los usuarios y las organizaciones, pero ¿qué pasa con el equipo que usan los clientes? ¿Los planes de suscripción que han comprado? ¿Los pedidos sobre los que están preguntando?
Los Objetos Personalizados de Zendesk resuelven este problema. Le permiten extender el modelo de datos de Zendesk para almacenar lo que sea importante para su negocio, luego conectar esos datos directamente a los tickets de soporte.
Esta guía cubre todo lo que necesita saber sobre la API de objetos personalizados de Zendesk. Ya sea que sea un desarrollador que crea integraciones, un administrador de Zendesk que extiende su instancia o un consultor técnico que implementa soluciones, encontrará ejemplos prácticos y patrones del mundo real que puede usar de inmediato. Para los equipos que buscan mejorar aún más su configuración de Zendesk, la integración de Zendesk de eesel AI puede ayudar a automatizar los flujos de trabajo de soporte utilizando sus datos personalizados.
¿Qué son los objetos personalizados de Zendesk?
Zendesk le ofrece objetos estándar listos para usar: tickets, usuarios, organizaciones y artículos. Estos funcionan muy bien para escenarios de soporte básicos. Pero las empresas son más complejas que eso.
Los objetos personalizados le permiten crear sus propias estructuras de datos dentro de Zendesk. Piense en ellos como tablas de base de datos que usted mismo define. Crea el objeto (la tabla), define sus campos (las columnas) y luego agrega registros (las filas).
Para trabajar eficazmente con objetos personalizados, necesita comprender cuatro conceptos centrales:
- Objetos personalizados - El contenedor o plantilla para sus datos. Esto define qué tipo de cosa está rastreando.
- Campos de objetos personalizados - El esquema que define qué propiedades tiene cada objeto. Sin campos, su objeto es solo una cáscara vacía.
- Campos de relación de búsqueda - Campos especiales que crean conexiones entre sus objetos personalizados y los objetos estándar de Zendesk (u otros objetos personalizados).
- Registros de objetos personalizados - Instancias individuales de sus datos personalizados. Si su objeto es "Software", cada registro es una pieza específica de software.
Los casos de uso comunes incluyen el seguimiento de activos de hardware (computadoras portátiles, impresoras), la gestión de licencias de software, la vinculación de pedidos de comercio electrónico a tickets de soporte o el almacenamiento de datos de suscripción. Cualquier escenario en el que necesite hacer referencia a datos específicos de la empresa durante las interacciones de soporte es un candidato para objetos personalizados. La documentación para desarrolladores de Zendesk proporciona tutoriales detallados sobre la implementación de estos casos de uso.
Nueva API vs API heredada: Lo que necesita saber
Aquí hay algo crítico que confunde a muchos desarrolladores: Zendesk tiene dos API de objetos personalizados completamente separadas. No son compatibles. Los datos creados con uno no pueden ser accedidos por el otro.
La Nueva API de Objetos Personalizados
La API moderna utiliza el punto final /api/v2/custom_objects y está profundamente integrada con el Espacio de Trabajo del Agente de Zendesk. Los registros aparecen de forma nativa en la interfaz, los campos de búsqueda funcionan en los formularios de tickets y toda la experiencia se siente como una característica nativa de Zendesk. Puede obtener más información sobre cómo comenzar con los objetos personalizados en la documentación oficial.
Esta es la API que debe usar para todos los proyectos nuevos.
La API de Objetos Personalizados Heredada
La API anterior usa /api/sunshine/ y fue el primer intento de Zendesk con datos personalizados. Funciona, pero se siente como un añadido en lugar de integrado. La documentación de la API de objetos personalizados heredada se refiere a esto como la "API de objetos personalizados heredada" y se mantiene principalmente para las implementaciones existentes.
Si está manteniendo una integración anterior, es posible que necesite esta API. De lo contrario, quédese con la nueva.
¿Cuál debería usar?
A menos que tenga una razón específica para usar la API heredada (como mantener el código existente), siempre elija la Nueva API de Objetos Personalizados. Está mejor documentada, mejor integrada y es donde Zendesk está invirtiendo el esfuerzo de desarrollo futuro.
Empezando: Requisitos previos y configuración
Antes de que pueda comenzar a hacer llamadas a la API, necesitará algunas cosas en su lugar.
Plan de Zendesk requerido
Los objetos personalizados no están disponibles en todos los planes. Según la documentación del plan de Zendesk, necesita uno de los siguientes:
- Support Enterprise
- Cualquier plan de Zendesk Suite (Team, Growth, Professional, Enterprise o Enterprise Plus)
El nivel del plan afecta la cantidad de objetos personalizados que puede crear, así que consulte la sección de límites más adelante en esta guía.
Habilitar objetos personalizados en el Centro de administración
Un administrador necesita activar la función antes de que pueda usarla.
- Vaya al Centro de administración
- Haga clic en Objetos y reglas en la barra lateral
- Seleccione Objetos personalizados > Objetos
- Haga clic en Comenzar
Si su cuenta usó previamente objetos personalizados heredados, verá un banner que ofrece probar la nueva experiencia. Haga clic en Pruébelo para habilitar la API moderna.
Crear un token de API
Todas las solicitudes de API usan Autenticación Básica con un token de API. La documentación de la API de Zendesk explica cómo crear uno:
- En el Centro de administración, vaya a Aplicaciones e integraciones > API > API de Zendesk
- Haga clic en la pestaña Configuración
- Habilite Acceso al token si aún no está activado
- Haga clic en el botón + para agregar un nuevo token
- Dele un nombre descriptivo como "Integración de objetos personalizados"
- Copie el token inmediatamente (Zendesk no lo mostrará de nuevo)
Formato de autenticación
Cada solicitud de API necesita un encabezado de Autorización con su correo electrónico y token:
Authorization: Basic {base64({email_address}/token:{api_token})}
Por ejemplo, si su correo electrónico es admin@company.com y su token es abc123xyz, codificaría en Base64 admin@company.com/token:abc123xyz e incluiría eso en el encabezado.
Trabajando con la API de Objetos Personalizados
Ahora repasemos las operaciones centrales que usará con más frecuencia.
Creando objetos personalizados
Para crear un objeto personalizado, envíe una solicitud POST a /api/v2/custom_objects con tres campos obligatorios:
- key - Un identificador único para el objeto (no se puede cambiar más tarde)
- title - El nombre para mostrar singular (por ejemplo, "Software")
- title_pluralized - El nombre para mostrar plural (por ejemplo, "Software")
Aquí hay un ejemplo de cURL:
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"
}
}'
Los campos opcionales incluyen:
- description - Lo que representa este objeto
- allows_attachments - Si los registros pueden tener archivos adjuntos
- include_in_list_view - Si los agentes ven este objeto en la página de registros de Objetos Personalizados
Definiendo campos de objetos personalizados
Un objeto sin campos es solo un contenedor vacío. Define el esquema utilizando la API de campos de objetos personalizados. La documentación oficial sobre la creación de objetos personalizados proporciona orientación adicional sobre la configuración de campos:
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"
}
}'
Los tipos de campo disponibles incluyen texto, área de texto, casilla de verificación, fecha, entero, decimal, regexp, menú desplegable, multiselección y búsqueda. Consulte la referencia de la API de campos de objetos personalizados para obtener detalles completos sobre cada tipo de campo.
Los campos de búsqueda son particularmente poderosos. Crean relaciones entre objetos. Para vincular su objeto de Software a los tickets, cree un campo de búsqueda en los tickets que apunte a Software:
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": "Affected Software",
"relationship_target_type": "zen:custom_object:software"
}
}'
Gestionando registros de objetos personalizados
Una vez que su objeto y sus campos estén configurados, puede crear registros.
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)
La API admite la paginación basada en cursor para listar registros, lo cual es más eficiente que la paginación de desplazamiento para conjuntos de datos grandes. Use los parámetros page[after] y page[size] para navegar a través de los resultados. Consulte la referencia de la API de registros de objetos personalizados para obtener detalles completos sobre la paginación.
Límites del plan y mejores prácticas
Comprender los límites le ayuda a diseñar dentro de las restricciones desde el principio.
Límites de objetos personalizados por plan
| Plan | Límite de objetos personalizados | Campos de búsqueda por objeto |
|---|---|---|
| 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 |
Otros límites importantes
- 100 campos máximos por objeto personalizado (los campos estándar no cuentan)
- 32 KB máximos por registro
- 50 millones de registros máximos por cuenta
- 100 registros por página al listar a través de la API
Mejores prácticas para el modelado de datos
Planifique las relaciones de sus objetos antes de comenzar a construir. Cambiar las claves o las estructuras fundamentales más adelante requiere recrear objetos y migrar datos.
Use el campo external_id para los registros al sincronizar con sistemas externos. Esto le permite hacer referencia a los registros por sus propios identificadores en lugar de los ID internos de Zendesk.
Para el rendimiento, use la paginación basada en cursor al iterar a través de grandes conjuntos de registros. La paginación de desplazamiento se vuelve más lenta a medida que avanza más profundamente en los resultados. Revise la documentación de paginación de la API de Zendesk para obtener consejos de optimización adicionales.
Integrando objetos personalizados en su flujo de trabajo
El verdadero poder de los objetos personalizados proviene de cómo se integran con el resto de Zendesk.
Formularios de tickets y Espacio de Trabajo del Agente
Cuando agrega campos de búsqueda a los formularios de tickets, los agentes pueden buscar y seleccionar registros de objetos personalizados directamente mientras ven los tickets. Los datos del registro seleccionado aparecen en la barra lateral del ticket, lo que brinda a los agentes un contexto completo sin cambiar de contexto. Consulte la guía de Zendesk sobre cómo comenzar con los objetos personalizados para obtener instrucciones de configuración.
Marco de aplicaciones de Zendesk
Puede crear aplicaciones de barra lateral que muestren datos de objetos personalizados en el Espacio de Trabajo del Agente. Esto es útil cuando necesita mostrar datos calculados, registros relacionados de sistemas externos o visualizaciones personalizadas que van más allá de lo que proporcionan los campos de búsqueda.
Disparadores y automatización
Los objetos personalizados funcionan con los disparadores de Zendesk, lo que le permite automatizar en función de los datos personalizados. Por ejemplo, podría enrutar automáticamente los tickets sobre licencias caducadas a un equipo de renovaciones, o escalar los problemas que afectan a los clientes VIP en función de los datos de un objeto personalizado.
Integración del sistema externo
La API permite la sincronización bidireccional con sistemas externos. Puede sincronizar los datos del catálogo de productos desde su plataforma de comercio electrónico, extraer información de activos de su sistema de gestión de activos de TI o enviar información de soporte a su CRM.
Usando eesel AI con datos personalizados de Zendesk
Una vez que tenga objetos personalizados que almacenen sus datos comerciales, puede poner esa información a trabajar en sus operaciones de soporte. En eesel AI, hemos construido nuestra plataforma para que funcione a la perfección con los datos de Zendesk, incluidos los objetos personalizados.
Nuestros agentes de IA pueden hacer referencia a los registros de objetos personalizados al responder a los tickets. Si un cliente pregunta sobre su licencia de software, la IA puede buscar el registro de la licencia, verificar las fechas de vencimiento y proporcionar información precisa sin intervención humana.
También utilizamos relaciones de objetos personalizados para personalizar las interacciones. Cuando la IA sabe qué productos usa un cliente (de sus objetos personalizados), puede adaptar las respuestas con contexto relevante y sugerir soluciones apropiadas.
Si está invirtiendo en objetos personalizados para modelar sus datos comerciales, considere cómo la IA puede aprovechar esa inversión. La combinación de datos personalizados estructurados y automatización inteligente crea experiencias de soporte que se sienten genuinamente útiles en lugar de genéricas. Puede probar eesel AI gratis y ver cómo funciona con su configuración de Zendesk.
Comience a construir con objetos personalizados de Zendesk hoy
La API de objetos personalizados de Zendesk le brinda las herramientas para modelar sus datos comerciales únicos e integrarlos directamente en su flujo de trabajo de soporte. Ha aprendido los conceptos centrales, la diferencia entre las versiones de la API, cómo autenticarse y las operaciones clave para crear objetos, definir campos y administrar registros.
Sus próximos pasos dependen de sus objetivos. Si está construyendo una integración, comience con una pequeña prueba de concepto, tal vez un objeto personalizado con algunos campos. Pruebe las operaciones CRUD, luego expanda a las relaciones y las conexiones del sistema externo.
Si es un administrador de Zendesk, trabaje con su equipo para identificar qué datos comerciales mejorarían más las interacciones de soporte. Las mejores implementaciones de objetos personalizados resuelven problemas reales que los agentes enfrentan a diario.
Y si está buscando obtener más valor de su inversión en Zendesk, explore cómo la IA puede aprovechar sus datos personalizados para un soporte más inteligente y personalizado. La combinación de datos estructurados y automatización inteligente es hacia donde se dirige el soporte moderno. Reserve una demostración para ver cómo eesel AI funciona con sus objetos personalizados de Zendesk.
Preguntas Frecuentes
Compartir esta entrada
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.
