Configurar el bot como notificador de webhook entrante

A continuación, configuremos el bot como un notificador de webhook entrante, que realiza acciones cuando se invoca la URL del webhook en GitHub. Puedes hacerlo de la siguiente manera:

1. Generar un token de webhook en el bot de Cliq
2. Obtener la App Key de tu extensión
3. Obtener la URL del webhook handler de tu extensión
4. Crear un webhook en GitHub y configurar estos valores

Analizaremos estas acciones en detalle una por una.

Este webhook se activa cada vez que se hace un push de un commit a uno de los repositorios en tu cuenta de Git. Cuando ocurre ese evento, GitHub realiza una solicitud HTTP a la URL del webhook handler con las credenciales que configuramos. Pasará los detalles de ese evento de push a Cliq, y el bot de Cliq te notificará y mostrará los detalles.

Generar un token de webhook

Puedes generar un token de webhook en Cliq como se describe a continuación. El token de webhook se autentica mediante la función de botón “authenticate” que configuramos en el paso anterior.

1. Busca el bot de GitHub en tu cuenta de Cliq. Selecciona el bot y haz clic en Continue.

2. Otorga permiso al bot para acceder a los detalles de tu cuenta.

Se activará el chat.

3. Escribe “webhooktoken” en el chat y presiona Enter. Luego haz clic en Create Webhook.

4. Haz clic en Create Webhook. En la ventana emergente que aparece, necesitaremos ingresar el token de webhook del bot.

Para obtener el token de webhook, haz clic en el ícono de Profile en la esquina superior derecha de la página.

Haz clic en Bots & Tools.

Haz clic en Webhook Tokens en el menú de Integrations.

Haz clic en Generate New Token y copia el token generado.

Pega el valor del token en la ventana emergente y haz clic en Submit.

Obtener la App Key

Puedes obtener la App Key de la extensión de la siguiente manera:

1. Haz clic en la extensión GitHubExt desde la página de extensiones en la consola de desarrollo de Cliq y luego navega a la sección Connectors.

2. Copia la Sandbox App Key de tu extensión.

Esta clave será el valor del parámetro appkey en la URL que configuraremos en GitHub.

Obtener la URL del webhook handler

Puedes obtener la URL del webhook handler de la extensión de la siguiente manera:

1. Navega de vuelta a tu cuenta de Cliq y haz clic en tu foto de perfil. Haz clic en Bots & Tools en la sección del menú.

2. Haz clic en GitHub Bot en tu lista de bots. Esto abrirá un panel lateral. Copia la URL que se muestra en Incoming WebHook Endpoint.

Esta será la baseURL que configuraremos en GitHub.

Crear un webhook en GitHub

La URL completa para configurar en GitHub es:

baseURL?appkey={{appkey}}&zapikey={{zapikey}}

donde baseURL es la URL del webhook handler, appkey es la Sandbox App Key de tu extensión y zapikey es el token de webhook generado en Cliq.

Por ejemplo:

https://cliq.zoho.com/company/org_id/api/v2/githubbot/incoming?appkey={{appkey}}&zapikey={{zapikey}}

Ahora agreguemos esta URL en GitHub de la siguiente manera:

1. Abre tu cuenta de GitHub y navega a cualquiera de tus repositorios.

2. Abre la configuración de tu repositorio y luego haz clic en Webhooks -> Add webhook.

3. Ingresa la URL en el formato especificado anteriormente, sustituyendo los valores de appkey y zapikey. Configura el webhook como se muestra a continuación.

Puedes seleccionar los eventos sobre los que te gustaría recibir notificaciones.

4. Haz clic en Add webhook.

Este webhook ahora habilitará alertas para los eventos configurados en tu repositorio.