Creación de webhooks en el Centro de administración

Acceso rápido: Centro de administración > Aplicaciones e integraciones > Webhooks > Webhooks

Un webhook envía una solicitud HTTP a un URL especificado como respuesta a un evento (por ejemplo, cuando se gatilla un disparador o una automatización en Zendesk Support). Los programadores web normalmente usan webhooks para invocar un comportamiento en otro sistema.

Nota: Las cuentas de prueba están limitadas a un máximo de 10 webhooks.

En este artículo se tratan los siguientes temas:

• Acerca de los webhooks
• Crear un webhook
• Probar un webhook

Acerca de los webhooks

Los webhooks se usan para la integración con servicios de terceros o con el sistema central. Por ejemplo, los webhooks se pueden usar para:

• Poner sobre aviso al equipo en Slack cuando se crea un ticket urgente
• Pasar los detalles del ticket al equipo de documentación en Asana después de resolver un ticket
• Notificar a sus propios servicios centrales sobre un evento de ticket importante

Los webhooks se pueden usar para pasar información a los servicios de terceros y las API de REST que admiten JSON, XML o contenido con codificación de formulario en solicitudes HTTP. También sirven para pasar parámetros de URL a cualquier URL.

Los webhooks se usan en las automatizaciones y los disparadores en Zendesk Support cuando un ticket cumple con ciertas condiciones especificadas. Son importantes porque, gracias a ellos, los disparadores y las automatizaciones pueden desencadenar acciones en función de las respuestas HTTP de servicios de terceros.

Se puede usar cualquiera de los marcadores de posición de contenido disponibles para insertar datos de ticket en las solicitudes HTTP.

Cuando una regla de negocio gatilla un webhook, pone el trabajo que se debe ejecutar en la cola, pero no ejecuta el trabajo inmediatamente. Debido a que los trabajos del webhook se ejecutan de manera independiente, no hay ninguna garantía de que los webhooks vayan a ejecutarse en un orden determinado.

Las solicitudes de webhooks se vuelven a probar automáticamente hasta tres veces si los extremos devuelven ciertos códigos de respuesta HTTP. A diferencia de los destinos, los webhooks no se desactivan si hay solicitudes fallidas consecutivas. Si desea obtener más información y ver ejemplos de situaciones de reintento, consulte el artículo Monitoring webhooks que se encuentra en la documentación para desarrolladores.

Crear un webhook

La creación de un webhook consta de dos partes. Primero, se definen los detalles del webhook en sí. Luego, se adjunta a un disparador o una automatización para poder usarlo.

Nota: Al configurar un webhook para la integración con un tercero, puede ser necesario consultar la documentación del servicio de terceros.

Para crear un webhook

1. En el Centro de administración, haga clic en Aplicaciones e integraciones en la barra lateral y luego seleccione Webhooks > Webhooks.
2. Haga clic en Acciones y seleccione Crear webhook.
3. Configure el webhook que desea integrar con el servicio o el sistema de terceros.

   Si desea más información, consulte Extremos de webhooks y Autenticar los webhooks.

4. (Opcional) Haga clic en Probar webhook para asegurarse de que esté funcionando como debe.
5. Haga clic en Siguiente para conectar el webhook a un disparador o una automatización de Support . Esto se hace en la interfaz de administración de Zendesk Support.
6. Regrese a la página Crear webhook en el Centro de administración y haga clic en Terminar configuración.

Después de crear un webhook y conectarlo a un disparador o una automatización, puede ver los detalles del webhook, las suscripciones a eventos y la actividad desde la página Webhooks del Centro de administración. Si desea más información, consulte Administración de webhooks en el Centro de administración.

Extremos de webhooks

Los webhooks envían solicitudes y reciben respuestas del URL de extremo que se especifica al crearlos. Así es como se integran con los servicios, las API y los sistemas de terceros.

El URL de extremo usa el siguiente formato: https://www.yourdomain.com/path.

Aunque no es un requisito, se recomienda usar HTTP seguro (HTTPS). Si se proporciona un URL de extremo seguro, se activa la autenticación y se pueden pasar los datos de manera segura.

Autenticar los webhooks

Si su webhook se está integrando con un extremo seguro, tiene tres opciones para autenticar el webhook y los datos que envía. Podría ser conveniente que consulte la documentación del servicio de terceros sobre los requisitos de autenticación de su extremo o que trabaje con un desarrollador de su equipo para determinar el método de autenticación correcto para su webhook.

• No se requiere: no hay autenticación configurada ni se requiere.
• Autenticación básica: utilice un nombre de usuario y una contraseña para autenticar el webhook.
• Token de portador: utilice un token de acceso OAuth para autenticar el webhook.

Si los desarrolladores desean más información sobre la autenticación de webhooks, consulte Webhook security and authentication.

Conectar un webhook a un disparador o una automatización

Para que un webhook pueda hacer cualquier cosa, primero se tiene que conectar con un disparador o una automatización. Los disparadores y las automatizaciones especifican las circunstancias en las cuales se debe invocar el webhook.

Para conectar un webhook a un disparador de Support

1. En el Centro de administración, haga clic en Objetos y reglas en la barra lateral y luego seleccione Reglas de negocio > Disparadores.
   Nota: Si está creando o editando un webhook, haga clic en Administrar reglas de negocio.
2. Cree un nuevo disparador o una nueva automatización o edite un disparador o una automatización existente. Para ello, pase el puntero del mouse por encima del icono de opciones () y haga clic en Editar.
3. Para los disparadores, bajo Acciones, haga clic en Agregar acción. Seleccione Notificar a webhook y luego seleccione su webhook. Haga clic en Guardar.

Para conectar un webhook a una automatización de Support

1. En el Centro de administración, haga clic en Objetos y reglas en la barra lateral y luego seleccione Reglas de negocio > Automatizaciones.
   Nota: Si está creando o editando un webhook, haga clic en Administrar reglas de negocio.
2. Cree un nuevo disparador o edite uno existente. Para ello, pase el puntero del mouse por encima del icono de opciones () y haga clic en Editar.
3. Para las automatizaciones, bajo Realizar estas acciones, haga clic en el icono para agregar acción (). Seleccione Notificaciones: Notificar a webhook y luego seleccione su webhook. Haga clic en Enviar.

Probar un webhook

En el Centro de administración, tiene la opción de probar el webhook con distintos orígenes de eventos y solicitudes. Además de acceder a los webhooks existentes con el fin de probarlos, también puede probar un webhook al crearlo o editarlo.

Para probar un webhook

1. En el Centro de administración, haga clic en Aplicaciones e integraciones en la barra lateral y luego seleccione Webhooks > Webhooks.
2. Ubique el webhook en la lista, haga clic en el icono del menú de opciones () en la fila del webhook y luego haga clic en Probar webhook.
3. En el panel Probar webhook, seleccione Probar origen de eventos. Esta opción permite probar el URL de extremo con un disparador adjunto o un ticket de muestra.
4. Ingrese los detalles de la solicitud de prueba: cuerpo, parámetros o encabezados de la solicitud.
5. Haga clic en Enviar prueba. La respuesta se ve en el panel que se encuentra debajo de la solicitud de prueba.