Con las integraciones de conversaciones los negocios pueden unificar los mensajes de todos los canales, el chatbot o las aplicaciones de terceros en una sola conversación y crear experiencias interactivas en todos lados.
- Un webhook.
- (Opcional) Un conjunto de claves API para interactuar con la API pública con un alcance de integración. Si desea información sobre cómo crear las claves API, consulte Uso de las claves de la API de conversaciones.
Nota: Las integraciones de conversaciones antes se llamaban webhooks en el panel de Sunshine Conversations.
Las integraciones de conversaciones se pueden crear a través de la página Integraciones de conversaciones en el Centro de administración.
La integración también se puede crear usando curl o Postman.
Este artículo contiene las siguientes secciones:
Crear y configurar conversaciones en el Centro de administración
En la página Integraciones de conversaciones, se puede:
Crear una nueva integración de conversaciones
-
En el Centro de administración, haga clic en Aplicaciones e integraciones en la barra lateral y seleccione Integraciones > Integraciones de conversaciones. Se abre la página Integraciones de conversaciones y todas las conversaciones creadas anteriormente aparecen en la lista.
Si esta es la primera vez que crea una integración en el Centro de administración, haga clic en Crear integración para ver la página Integraciones de conversaciones.
- Haga clic en Crear integración. Se abre la página Crear integración.
- Ingrese un nombre único para identificar la integración.
- En la sección Webhook, ingrese la siguiente información:
-
URL del extremo de webhook: el URL destino. Cuando ocurre un evento disparador, el webhook ve el evento y envía los datos al URL de destino. El URL de destino usa el siguiente formato:
https://www.yourdomain.com/path
. - Datos del cuerpo del webhook: utilice las casillas de verificación para indicar si desea incluir el esquema de usuario y la información del cliente y dispositivo en los datos del webhook.
- Suscripciones de webhook: seleccione los eventos sobre los cuales desea recibir notificación.
-
URL del extremo de webhook: el URL destino. Cuando ocurre un evento disparador, el webhook ve el evento y envía los datos al URL de destino. El URL de destino usa el siguiente formato:
- Haga clic en Guardar. Se abre la ventana Copiar secreto compartido.
- (Opcional) Copie la ID del webhook y el secreto compartido. Los desarrolladores los utilizan para agregar otra capa de autenticación, pero no son obligatorios.
- Haga clic en Siguiente. Se abre la página de configuración de la integración donde se puede agregar una clave API, si es necesario.
Agregar una clave API
En la pestaña Clave API, se puede configurar la autenticación para la integración. Una clave API identifica y autentica una aplicación o un usuario y está compuesta de tres partes.
- La ID de la aplicación identifica la cuenta de Zendesk.
- La ID de clave junto con la clave secreta son las credenciales utilizadas para autenticar los JWT y las llamadas de API.
- La clave secreta es la contraseña de autenticación.
Para crear y compartir una clave API
- En el Centro de administración, haga clic en Aplicaciones e integraciones en la barra lateral y seleccione Integraciones > Integraciones de conversaciones. Se abre la página Integraciones de conversaciones.
- Haga clic en la pestaña Clave API.
- Haga clic en Crear clave de API. Si está creando su primera clave, este botón aparecerá en la parte inferior de la página; si ya ha creado una clave anteriormente, aparecerá en la esquina superior derecha.
- Ingrese un nombre identificador para la clave en el cuadro de diálogo Crear nueva clave y luego haga clic en Siguiente.
- En el cuadro de diálogo Copiar secreto compartido, haga clic en Copiar para cada ID y clave secreta para guardarlas en el portapapeles y luego haga clic en Siguiente. Volverá a la ventana de la API, donde la nueva clave aparece en la lista.
Si genera una nueva clave pero ya ha alcanzado su límite de 10 claves, aparecerá una notificación que le indica que debe borrar las claves no utilizadas.
Para borrar una clave no utilizada
- En el Centro de administración, haga clic en Aplicaciones e integraciones en la barra lateral y seleccione Integraciones > Integraciones de conversaciones.
- Haga clic en la pestaña Clave API.
- Pase el puntero del mouse por encima de la clave que desea borrar, luego haga clic en el menú de opciones () y seleccione Borrar.
Ver, editar y borrar una integración
Para trabajar con una integración existente
- En el Centro de administración, haga clic en Aplicaciones e integraciones en la barra lateral y seleccione Integraciones > Integraciones de conversaciones. Se abre la página Integraciones de conversaciones.
- Pase el mouse por encima de la integración que desea actualizar y haga clic en el icono Opciones () y luego seleccione una opción:
- Ver detalles: muestra la página de detalles de la integración, donde puede ver las ID de la aplicación, de la integración y del webhook, además de información sobre los secretos compartidos, los detalles del webhook y las claves API.
- Editar: abre la página Crear integración, donde puede actualizar el nombre de la integración y los detalles del webhook.
- Borrar: inicia el asistente de borrado. Puede cancelar y salir del asistente en cualquier momento.
Otros métodos de integración
Estos métodos están disponibles solo para los usuarios que tienen una licencia separada de Sunshine Conversations, no la licencia que viene con el plan Zendesk Suite Professional o planes superiores.
Para crear una integración de conversaciones usando curl
- Cree una integración usando la API Create Integration y establezca
type
encustom
. - Proporcione los parámetros necesarios como se especifica en la API. El destino es el URL de su servidor y la lista de disparadores determina qué eventos se reciben.
Para crear una integración de conversaciones usando Postman
- Cree una integración usando la API Create Integration y establezca
type
encustom
. - Descargue e instale la aplicación Postman.
- Descargue Postman Collection de Sunshine Conversations y configure el entorno.
- En Postman, seleccione Smooch > Integrations > Create Integrations.
- Proporcione los parámetros necesarios como especifica el tipo de integración.
Si desea más información sobre las API de Sunshine Conversations, consulte Integrations.
También puede consultar las guías sobre cómo enviar y recibir mensajes. Se recomienda configurar los webhooks usando las API de REST.