Zendesk

Configurar la autenticación

Introduce los detalles en función de la autenticación que quieras usar.

• Nombre de usuario y contraseña (obsoleto)
  • Nombre de usuario: el nombre de usuario de Zendesk que se usará para la conexión.
  • Contraseña: secreto de Secret Manager que contiene la contraseña asociada al nombre de usuario de Zendesk.
• Token de API
  • Usuario: la cuenta de usuario de Zendesk que se usa para la autenticación.
  • Token de API: el token de API del usuario autenticado.
  • Versión de secreto: versión del secreto.
• OAuth 2.0 - Código de autorización
  • ID de cliente: el ID de cliente proporcionado por el conector de la aplicación que has creado.
  • Scopes: lista separada por comas de los permisos deseados.
  • Secreto de cliente: secreto de Secret Manager que contiene el secreto de cliente de la aplicación conectada que has creado.
  • Versión de secreto: versión del secreto.
  • URL de autorización: URL de autorización generada al crear el cliente en la instancia de Zendesk.

Configurar la suscripción a eventos

Si ha habilitado la suscripción a eventos, introduzca los siguientes valores en la sección Event Subscription Details (Detalles de la suscripción a eventos):

1. Selecciona un Tipo de destino.
   • Dirección del host: introduce la URL de registro de tu sistema backend en el campo host.
2. Seleccione Token de API como tipo de autenticación. No selecciones Nombre de usuario y contraseña.
3. Introduce los detalles de autenticación.
   1. Usuario: la cuenta de usuario de Zendesk que se usa para la autenticación.
   2. Token de API: el token de API del usuario autenticado.
   3. Versión de secreto: versión del secreto.
4. También puedes seleccionar Habilitar el enriquecimiento de datos si quieres que se añada información adicional a la respuesta del sistema backend.

   La información adicional es específica de la entidad para la que ha configurado el evento. Para obtener más información, consulta Enriquecimiento de datos en notificaciones de eventos.

5. Selecciona Habilitar conectividad privada para establecer una conexión segura entre tu aplicación backend y tu conexión. Si seleccionas esta opción, debes seguir unos pasos de configuración adicionales después de crear la conexión. Para obtener más información, consulta Conectividad privada para la suscripción a eventos.
6. Introduce la configuración de la cola de mensajes fallidos. Si configura mensajes fallidos, la conexión escribe los eventos no procesados en el tema de Pub/Sub especificado. Introduzca los siguientes detalles:
   1. ID de proyecto de mensajes fallidos: el ID del proyecto de Google Cloud en el que has configurado el tema de mensajes fallidos de Pub/Sub.
   2. Tema de mensajes fallidos: el tema de Pub/Sub en el que quieres escribir los detalles del evento no procesado.
7. Si quieres usar un proxy para conectarte a tu backend (para la suscripción a eventos), introduce los siguientes detalles:
1. Tipo de SSL de proxy: el tipo de SSL que se debe usar al conectarse al servidor proxy. Seleccione uno de los siguientes tipos de autenticación:
   • Siempre: la conexión siempre tiene habilitado el protocolo SSL para la suscripción a eventos.
   • Nunca: la conexión no tiene habilitado el protocolo SSL para la suscripción a eventos.
2. Esquema de autenticación de proxy: selecciona el tipo de autenticación para autenticarte con el servidor proxy. Se admiten los siguientes tipos de autenticación:
   • Básica: autenticación HTTP básica.
3. Usuario del proxy: introduzca el nombre de usuario que se usará para autenticarse en el servidor proxy.
4. Contraseña de proxy: selecciona el secreto de Secret Manager de la contraseña del usuario.
5. Versión del secreto: selecciona la versión del secreto.
6. En la sección Servidor proxy, introduce los detalles del servidor proxy.
   1. Haga clic en + Añadir destino y, a continuación, seleccione Tipo de destino como Dirección de host.
   2. Introduce el nombre de host o la dirección IP del servidor proxy, así como el número de puerto del servidor proxy.

Ejemplos de configuración de conexiones

Tipo de conexión de autenticación básica (obsoleto)

Tipo de conexión de token de API

OAuth 2.0: tipo de conexión de código de autorización

La conexión a Zendesk usa SSL de forma predeterminada y no se necesita ninguna configuración adicional si usas la URL estándar de Zendesk, como https://yoursubdomain.zendesk.com.

Entidades, operaciones y acciones

Todos los conectores de integración proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se te muestra como entidades, operaciones y acciones.

• Entidad: una entidad se puede considerar como un objeto o un conjunto de propiedades en la aplicación o el servicio conectados. La definición de una entidad varía de un conector a otro. Por ejemplo, en un conector de base de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; y en un conector de sistema de mensajería, las colas son las entidades.

  Sin embargo, es posible que un conector no admita o no tenga ninguna entidad. En ese caso, la lista Entities estará vacía.

• Operación: una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Mostrar
  • Obtener
  • Crear
  • Actualizar
  • Eliminar

  Al seleccionar una entidad de la lista disponible, se genera una lista de operaciones disponibles para la entidad. Para ver una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea Connectors. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se mostrarán en la lista Operations.

• Acción: una acción es una función de primera clase que se pone a disposición de la integración a través de la interfaz del conector. Una acción te permite hacer cambios en una o varias entidades y varía de un conector a otro. Normalmente, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Limitaciones del sistema

El conector de Zendesk puede procesar 5 transacciones por segundo, por nodo, y limita las transacciones que superen este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para mejorar la disponibilidad) a una conexión.

Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.

Acciones

El conector de Zendesk proporciona acciones para gestionar tus incidencias en función de la ticket ID. Para saber cómo configurar las acciones, consulta los ejemplos de acciones.

Ejemplos de acciones

En esta sección se describe cómo realizar algunas de las acciones de este conector.

Ejemplo: eliminar un billete

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción DeleteTicketsPermanently y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
     "Id": "18"
   }

En este ejemplo, se elimina la incidencia de forma permanente. Si la acción se realiza correctamente, el parámetro connectorOutputPayload de la respuesta de la tarea del conector tendrá un valor similar al siguiente:

[{
  "Success": "true"
}] 

Ejemplo: combinar entradas

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción MergeTickets y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
     "Id": "25",
     "Id": "26"
   }

En este ejemplo se combinan los dos tickets. Si la acción se realiza correctamente, el parámetro connectorOutputPayload de la respuesta de la tarea del conector tendrá un valor similar al siguiente:

[{
  "Success": null,
  "Message": null
}] 

Ejemplo: Restaurar un ticket

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción RestoreTicket y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
     "id": "20"
   }

En este ejemplo se restaura un ticket. Si la acción se realiza correctamente, el parámetro connectorOutputPayload de la respuesta de la tarea del conector tendrá un valor similar al siguiente:

[{
  "Success": "true"
}] 

Ejemplo: Recuperar un ticket suspendido

1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
2. Seleccione la acción RecoverSuspendedTicket y, a continuación, haga clic en Hecho.
3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
     "id": "18726501985809"
   }

En este ejemplo se recupera el ticket suspendido. Si la acción se realiza correctamente, el parámetro connectorOutputPayload de la respuesta de la tarea del conector tendrá un valor similar al siguiente:

[{
  "Id": "60921"
}]

Ejemplos de operaciones de entidades

Ejemplo: operación de lista en Tickets

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Tickets en la lista Entity.
3. Selecciona la operación List y, a continuación, haz clic en Hecho.

Puedes realizar la operación List en las siguientes entidades:

Adjuntos, comentarios de tickets, formularios de tickets, campos de tickets, solicitudes, auditorías de tickets, métricas de tickets, tickets suspendidos, acuerdos de uso compartido, usuarios, identidades de usuario, información relacionada con el usuario, campos de usuario, campos de organización y estados de trabajos

Ejemplo: operación Get en Tickets

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Tickets en la lista Entity.
3. Selecciona la operación Get y, a continuación, haz clic en Hecho.
4. En este caso, el valor de entityId es 34.0. Para definir el entityId, en la sección Entrada de tarea de la tarea Conectores, haga clic en entityId y, a continuación, introduzca 34.0 en el campo Default Value.

Puedes realizar la operación Get en las siguientes entidades:

Formularios de tickets, campos de tickets, solicitudes, auditorías de tickets, tickets suspendidos, campos de usuario, UserIdentities y Users

Ejemplo: crear una operación en Tickets

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Tickets en la lista Entity.
3. Selecciona la operación Create y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
       "Subject": "Zendesk_Create_Ticket",
       "RawSubject": "Zendesk_Create",
       "Description": "this ticket is related to application integration Create operation",
       "Type": "incident",
       "Priority": "urgent",
       "Status": "open",
       "Recipient": null,
       "HasIncidents": false,
       "DueAt": null,
       "RequesterId": 3.84625885158E11,
       "SubmitterId": 3.84625883418E11,
       "AssigneeId": 3.84625883418E11,
       "OrganizationId": "16665992392721",
       "GroupId": 3.60008282358E11,
       "TicketFormId": 3.60001719218E11,
       "BrandId": 3.60003285058E11,
       "Tags": null,
       "ViaChannel": "web",
       "ViaSource": "{\r\n  \"from\": null,\r\n  \"to\": null,\r\n  \"rel\": null\r\n}",
       "CustomFields": null,
       "SatisfactionRating": null,
       "SharingAgreementIds": null,
       "AllowChannelback": false,
       "IsPublic": true,
       "Url": "https://altostrat.zendesk.com/api/v2/tickets/1.json"
     }
     

   Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    {
       "Id": 38.0
     }
     

Ejemplo: operación de creación en TicketForms

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona TicketForms en la lista Entity.
3. Selecciona la operación Create y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
       "Name": "Altostrat_Zendesk1",
       "RawName": "Altostrat_Zendesk1",
       "DisplayName": "Altostrat_Issues1",
       "RawDisplayName": "Altostrat_Issues1",
       "Position": 2.0,
       "Active": true,
       "EndUserVisible": true,
       "Default": false,
       "InAllBrands": true,
       "RestrictedBrandIds": null,
       "FallbackToDefault": null,
       "AssociatedToBrand": null
     }
     

   Si la integración se realiza correctamente, el parámetro connectorOutputPayload response de la tarea TicketForms tendrá un valor similar al siguiente:

   {
       "Id":1.8104712053393E13
     }
     

Ejemplo: crear una operación en TicketFields

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona TicketFields en la lista Entity.
3. Selecciona la operación Create y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
       "Type": "text",
       "Title": "New field created",
       "RawTitle": null,
       "Description": "Please create the new field",
       "RawDescription": null,
       "Position": 2.0,
       "Active": true,
       "Required": false,
       "CollapsedForAgents": false,
       "RegexpForValidation": null,
       "VisibleInPortal": true,
       "EditableInPortal": true,
       "Tag": null,
       "CreatedAt": "2021-07-06 06:35:19.0",
       "UpdatedAt": "2021-07-06 06:35:19.0",
       "SystemFieldOptions": null,
       "CustomFieldOptions": null,
       "Removable": false
     }
     

   Si la integración se realiza correctamente, el parámetro connectorOutputPayload response de la tarea TicketFields tendrá un valor similar al siguiente:

   {
       "Id": 1.7139061374865E13
     }
     

Ejemplo: operación de creación en SharingAgreements

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona SharingAgreements en la lista Entity.
3. Selecciona la operación Create y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
       "Name": "altostrat.zendesk.com",
       "RemoteSubdomain": "altostrat"
     }
     

   Si la integración se realiza correctamente, el parámetro connectorOutputPayload response de la tarea SharingAgreements tendrá un valor similar al siguiente:

   {
       "Id": 1.7142672288273E13
     }
     

Ejemplo: operación de creación en Users

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Users en la lista Entity.
3. Selecciona la operación Create y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
       "Email": "cloudysanfrancisco@gmail.com",
       "Name": "Altostrat Team"
     }
     

   Si la integración se realiza correctamente, el parámetro connectorOutputPayload response de la tarea Users tendrá un valor similar al siguiente:

   {
       "Id": 1.7156912480273E13
     }
     

Ejemplo: operación de creación en UserIdentities

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona UserIdentities en la lista Entity.
3. Selecciona la operación Create y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
       "UserId": 3.84637722338E11,
       "Type": "email",
       "Value": "cloudysanfrancisco@gmail.com",
       "Verified": false,
       "Primary": true,
       "DeliverableState": "reserved_example",
       "Url": "https://d3valtostrat1625553311.zendesk.com/api/v2/users/384637722338/identities/368240277818.json"
     }
     

   Si la integración se realiza correctamente, el parámetro connectorOutputPayload response de la tarea UserIdentities tendrá un valor similar al siguiente:

   {
       "Id": 1.6961185982353E13
     } 
     

Ejemplo: operación de creación en UserFields

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona UserFields en la lista Entity.
3. Selecciona la operación Create y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
       "Title": "Support description",
       "Type": "text",
       "Key": "support_description"
     }
     

   Si la integración se realiza correctamente, el parámetro connectorOutputPayload response de la tarea UserFields tendrá un valor similar al siguiente:

   {
       "Id": 1.7157236761873E13
     }
     

Ejemplo: operación de actualización en Tickets

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Tickets en la lista Entity.
3. Selecciona la operación Update y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
       "Subject": "Google_Altostrat_Zendesk Update",
       "RawSubject": "Google_Altostrat_Zendesk Update",
       "Description": "this ticket is related to googlecloud application integration update check",
       "RequesterId": 1.6854335860497E13
     }
     

5. En este caso, el valor de entityId es 35.0. Para definir el entityId, haga clic en entityId y, a continuación, introduzca 35 en el campo Valor predeterminado.

   En lugar de especificar el entityId, también puede definir filterClause como 35.

   Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

   {
         Id": 35.0
     }
     

Ejemplo: operación de actualización en TicketForms

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona TicketForms en la lista Entity.
3. Selecciona la operación Update y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
       "Name": "Ticketforms Updated",
       "DisplayName": "Altostrat_Issues1",
       "RawDisplayName": "Altostrat_Issues1"
     }
     

5. En este caso, el valor de entityId es 1.7137314972689E13. Para definir el entityId, haga clic en entityId y, a continuación, introduzca 1.7137314972689E13 en el campo Valor predeterminado.

   En lugar de especificar el entityId, también puede definir filterClause como 1.7137314972689E13.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

   {
         Id": 1.7137314972689E13
     }
     

Ejemplo: operación de actualización en TicketFields

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona TicketFields en la lista Entity.
3. Selecciona la operación Update y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
       "Description": "Updated description for testing"
     }
     

5. En este caso, el valor de entityId es 3.60022990118E11. Para definir el entityId, haga clic en entityId y, a continuación, introduzca 3.60022990118E11 en el campo Valor predeterminado.

   En lugar de especificar el entityId, también puede definir filterClause como 3.60022990118E11.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

   {
         Id": 3.60022990118E11
     }
     

Ejemplo: operación de actualización en Users

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Users en la lista Entity.
3. Selecciona la operación Update y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
       "Name": "The Customer update",
       "Last Name": "Alex",
       "First Name": "Charlie"
     }
     

5. En este caso, el valor de entityId es 3.84625885158E11. Para definir el entityId, haga clic en entityId y, a continuación, introduzca 3.84625885158E11 en el campo Valor predeterminado.

   En lugar de especificar el entityId, también puede definir filterClause como 3.84625885158E11.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

   {
         Id": 3.84625885158E11
     }
     

Ejemplo: operación de actualización en UserFields

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona UserFields en la lista Entity.
3. Selecciona la operación Update y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
       "Title": "Support description updated",
       "Type": "text",
       "Key": "support_description"
     }
     

5. En este caso, el valor de entityId es 1.7157236761873E13. Para definir el entityId, haga clic en entityId y, a continuación, introduzca 1.7157236761873E13 en el campo Valor predeterminado.

   En lugar de especificar el entityId, también puede definir filterClause como 1.7157236761873E13.

   Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea Connector:

   {
         Id": 1.7157236761873E13
     }
     

Ejemplo: operación de actualización en UserIdentities

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona UserIdentities en la lista Entity.
3. Selecciona la operación Update y, a continuación, haz clic en Hecho.
4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:

   {
       "Verified": true
     }
     

5. En esta entidad, la operación Update se puede realizar usando la cláusula de filtro y las claves principales compuestas, por lo que no se necesita entityId.

En lugar de especificar entityId, también puede definir filterClause como UserId='384625885158' and Id='368234205078' .

Al ejecutar este ejemplo, se devuelve una respuesta similar a la siguiente en la variable de salida connectorOutputPayload de la tarea del conector:

{
    "Id": 3.68234205078E11
  }
  

Ejemplo: operación de eliminación en Tickets

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona Tickets en la lista Entity.
3. Selecciona la operación Delete y, a continuación, haz clic en Hecho.
4. En este caso, el valor de entityId es 35.0. Para definir el entityId, en la sección Entrada de tarea de la tarea Conectores, haga clic en entityId y, a continuación, introduzca 35 en el campo Valor predeterminado.

Puedes realizar la operación de eliminación en las siguientes entidades:

Campos de ticket, tickets suspendidos, UserIdentities, campos de usuario y usuarios

Usar la conexión de Zendesk en una integración

Una vez que hayas creado la conexión, estará disponible tanto en Apigee Integration como en Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.

• Para saber cómo crear y usar la tarea Conectores en la integración de Apigee, consulta Tarea Conectores.
• Para saber cómo crear y usar la tarea Conectores en Application Integration, consulta Tarea Conectores.