Cómo conectar Sanity a Shopify Flow
Sanity envía un Webhook impulsado por GROQ cada vez que se crea, actualiza o elimina contenido que coincida con su consulta. 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 Shopify Flow pueda hacer.
Esta guía establece todo el proceso - Sanity envía, Workflow Webhooks recibe y verifica, Shopify Flow actúa - con la firma HMAC de Sanity comprobada en cada solicitud, de modo que solo Sanity pueda iniciar su flujo de trabajo.
Lo que puede construir
- Actualice el metacampo Shopify cuando se modifique la entrada correspondiente del CMS, de modo que la tienda online se mantenga sincronizada.
- Envíe un correo electrónico a su equipo de comercialización cuando se publique una página de destino.
- Inicie un flujo de trabajo de actualización de la caché tras la publicación de contenidos.
Eventos típicos que se envían: se publica un documento, se actualiza un documento, se elimina un documento.
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 Sanity 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
Sanity events. - En «Autenticación», seleccione HMAC.
- En «Proveedor de firma», seleccione «Sanity». La aplicación rellena automáticamente los campos «Encabezado», «Algoritmo», «Payload firmado» y «Ventana de repetición»; no es necesario 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 elegir qué campos se envían a Shopify Flow.
Paso 2: Añada el punto final en Sanity
En Sanity, vaya a API -> Webhooks, cree un webhook basado en GROQ con la URL que ha copiado y configure el secreto.
Cómo encontrar su secreto de firma de Sanity
La configuración de «The Secret» en el webhook impulsado por GROQ.
La propia documentación de Sanity sobre las firmas de webhooks, disponible en, contiene la redacción exacta 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 Sanity se verificará antes de llegar a Shopify Flow.
Qué comprueba esto
| ¿Qué? | Valor |
|---|---|
| Encabezado de la firma | sanity-webhook-signature |
| Dónde se coloca la firma | En el valor v1 de ese encabezado, que contiene pares key=value separados por comas |
| ¿Qué se ha firmado? | {timestamp}.{body} |
| Firma | HMAC-SHA256, codificado en base64url |
| Marca de tiempo | El valor t del encabezado de la firma, expresado en milisegundos de Unix |
| 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 carga útil firmada, {body} es el cuerpo de la solicitud sin procesar, byte a byte, y {timestamp} es la marca de tiempo mencionada anteriormente.
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 Sanity (o utilice la opción «Enviar prueba» en Workflow Webhooks) para que Shopify Flow aprenda la estructura de sus datos.
- Cada webhook que tenga activa el mismo activador de flujo; por lo tanto, añada una primera condición basada en el identificador del webhook para que este flujo de trabajo se limite exclusivamente a Sanity. El identificador 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, actualice un metacampo.
Paso 4: Realice una prueba de extremo a extremo
Activador de un evento real en Sanity. En «Workflow Webhooks» -> «History» debería ver la invocación con el estado «Success». 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 produjo el error.
La firma no coincide▾
En este pedido: el secreto (la causa más habitual - un espacio de más o una clave del entorno equivocado - ), si el remitente está utilizando el secreto de otro punto final y si hay algún elemento entre Sanity 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 Sanity seleccionado, que se haya introducido el secreto y que Sanity esté enviando la solicitud a la URL tal y como la muestra 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 Sanity y consulte el registro de entrega de Sanity para ver la respuesta que se 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 Sanity.
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 del payload y introducirlos en Shopify Flow.
- Protección contra entregas duplicadas - ¿Qué ocurre cuando Sanity vuelve a intentar realizar una entrega?
- Historial y resolución de problemas - el registro de todas las solicitudes, con la posibilidad de reproducirlas.