Cómo conectar GitHub a Shopify Flow
GitHub envía un Webhook cada vez que ocurre algo en un repositorio o en una organización: un «push», una versión, una incidencia, una solicitud de incorporación de cambios o la ejecución de un flujo de trabajo. «Workflow Webhooks» convierte esa llamada en un activador de «Shopify Flow», de modo que su tienda pueda reaccionar ante ella: etiquetar a un cliente, añadir una nota al pedido, enviar un correo electrónico interno, actualizar un metacampo… cualquier cosa que pueda hacer Shopify Flow.
Esta guía establece todo el proceso - GitHub envía, Workflow Webhooks recibe y verifica, Shopify Flow actúa - con la firma HMAC de GitHub comprobada en cada solicitud, de modo que solo GitHub puede iniciar su flujo de trabajo.
Lo que puede construir
- Envíe un correo electrónico a su equipo de comercialización cuando se publique una actualización que modifique los datos de los productos.
- En cada lanzamiento, introduzca la versión actual de la compilación o del tema en un metacampo de la tienda.
- Avise al personal cuando falle la ejecución de un flujo de trabajo programado, utilizando el mismo Shopify Flow que ya utiliza para otras incidencias.
Eventos típicos que se envían: push, release (publicado), issues (abierto, cerrado), workflow_run (completado).
Antes de empezar
- Workflow Webhooks instalado en su tienda de Shopify.
- Shopify Flow instalada, que se puede descargar de forma gratuita desde la App Store de Shopify.
- Una cuenta en GitHub con permiso para crear webhooks.
Paso 1: Cree el webhook en Workflow Webhooks
- Acceda a Workflow Webhooks -> Webhooks -> Crear webhook y asígnele un nombre que pueda reconocer en Shopify Flow, como por ejemplo
GitHub events. - En «Autenticación», seleccione HMAC.
- En «Proveedor de firma», seleccione GitHub. La aplicación rellena automáticamente los campos «encabezado», «algoritmo», «payload firmado» y «ventana de repetición»; no hay que configurar nada más.
- Deje el campo «Secreto» en blanco por ahora y haga clic en «Guardar». Copie la URL del webhook que aparece en la página.
Consulte Autenticación para conocer los demás modos de autenticación, y Asignación de la carga útil y variables de flujo para seleccionar qué campos se envían a Shopify Flow.
Paso 2: Añada el punto final en GitHub
En el repositorio (u organización), abra «Configuración» → «Webhooks» → «Añadir webhook», pegue la URL en el campo «URL de payload», establezca el tipo de contenido en application/json y rellene el campo «Secreto».
Cómo encontrar su secreto de firma de GitHub
El secreto que ha configurado en el webhook de GitHub (Configuración -> Webhooks -> Secreto).
La propia documentación de GitHub sobre las firmas de webhooks, disponible en, incluye el texto exacto y las capturas de pantalla correspondientes a su cuenta.
Pegue esa clave secreta en el campo «Secret» del webhook en Workflow Webhooks y guarde los cambios. A partir de ese momento, cada entrega de GitHub se verificará antes de llegar a Shopify Flow.
Qué comprueba esto
| ¿Qué? | Valor |
|---|---|
| Encabezado de la firma | X-Hub-Signature-256 |
| Dónde se coloca la firma | El valor del encabezado, tras el prefijo sha256= |
| ¿Qué se ha firmado? | {body} |
| Firma | HMAC-SHA256, codificado en hexadecimal |
| Marca de tiempo | Este remitente no lo utiliza |
| Protección contra la reproducción | Ninguna: este remitente no firma la marca de tiempo, por lo que todas las firmas válidas siguen siendo válidas. |
| El secreto | Se utiliza como texto sin formato. Péguelo tal y como lo muestra el remitente. |
En la payload firmada, {body} constituye el cuerpo de la solicitud sin procesar, byte a byte.
Cualquier solicitud que incumpla alguno de estos requisitos se rechaza con el código de error 401, se registra en Historial y resolución de problemas y nunca inicia un flujo de trabajo.
Paso 3: Crear el flujo de trabajo Shopify Flow
- En «Shopify Flow», cree un flujo de trabajo y seleccione el activador «Workflow Webhooks».
- Haga clic en «Grabar eventos» y, a continuación, envíe un evento de prueba desde GitHub (o utilice la opción «Enviar prueba» en Workflow Webhooks) para que Shopify Flow aprenda la estructura de sus datos.
- Cada webhook del que disponga activa el mismo activador de Flow, por lo que debe añadir una primera condición basada en el ID del webhook para que este flujo de trabajo se limite exclusivamente a GitHub. El ID aparece en la página del webhook.
- Añada sus acciones: etiquete a un cliente, añada una nota, envíe un correo electrónico interno o actualice un metacampo.
Paso 4: Pruebe el sistema de principio a fin
Activador de eventos reales en GitHub. En Workflow Webhooks -> Historial debería ver la invocación con el estado «Éxito». Si la firma era incorrecta, aparecerá en su lugar una entrada de error con el motivo correspondiente, y en Verificación de webhooks firmados se explica cómo funciona el verificador de firmas, que le muestra exactamente en qué paso se ha producido el error.
La firma no coincide▾
En este pedido: el secreto (la causa más habitual: un espacio de más o una clave de un entorno incorrecto), si el remitente está utilizando el secreto de otro punto final y si hay algún elemento entre GitHub y la aplicación que reescriba el cuerpo del mensaje. Las firmas abarcan los bytes sin procesar, por lo que un proxy que reformatee el JSON las invalida. El verificador de firmas de la página de webhooks muestra el texto exacto que se ha firmado.
Me aparece el error 401 en todas las solicitudes▾
Compruebe que la autenticación del webhook esté configurada como HMAC con el proveedor GitHub seleccionado, que se haya introducido el secreto y que GitHub esté enviando la solicitud a la URL tal y como aparece en la aplicación, incluido el código al final.
No aparece nada en el historial▾
La solicitud nunca se recibió. Vuelva a comprobar la URL en GitHub y consulte el propio registro de entrega de GitHub para ver la respuesta que recibió. Un error 404 indica que el webhook es incorrecto o ha sido eliminado; un error 429 significa que ha superado el límite de invocaciones de su plan; consulte Planes y uso.
El flujo de trabajo se ejecuta para eventos incorrectos▾
Cada webhook de su tienda activa el mismo activador de Shopify Flow. Añada una condición basada en el ID del webhook como primer paso del flujo de trabajo, o limite los eventos que envía desde GitHub.
Relacionado
- Verificación de webhooks firmados - todos los proveedores que verificamos, y cómo describir a aquellos que no verificamos.
- Asignación de la carga útil y variables de flujo - extraer los campos adecuados de la payload e introducirlos en Shopify Flow.
- Protección contra entregas duplicadas - ¿Qué ocurre cuando GitHub vuelve a intentar realizar una entrega?
- Historial y resolución de problemas - el registro de todas las solicitudes, con la posibilidad de reproducirlas.