Cree su primer webhook

Este tutorial le guiará desde una aplicación vacía hasta un flujo de trabajo de Shopify Flow que se ejecuta cuando su propio sistema lo indique. Dura unos diez minutos.

1. Cree un webhook

Webhooks -> Crear un webhook. La página le pregunta en primer lugar qué es lo que activará este webhook y lo configura para que coincida con ello:

Su respuesta Lo que obtendrá
Una herramienta de automatización (n8n, Make, Zapier, su propio código) Un token generado, listo para pegarlo en la herramienta
Un servicio que firma sus webhooks (Stripe, GitHub, etc.) Verificación de la firma para el servicio que elija: consulte Verificación de webhooks firmados
Un script para un navegador o una tienda online CORS activado: consulte CORS, la URL del proxy de la aplicación y las llamadas del navegador
Nada: ejecútelo según un horario Un webhook que recupera una URL de forma periódica; a continuación se abre su pestaña «Programación»; consulte Consulta programada de direcciones URL
¿Algo más, o lo decide más adelante? Usted mismo elige el método de autenticación

Asigne un nombre que pueda reconocer más adelante («Recordatorio de la tarjeta de cartera», «Formulario de contacto») y guarde los cambios. Todos los ajustes se pueden modificar posteriormente.

Ahora dispone de una URL de webhook que termina en un código corto, por ejemplo, https://.../webhook/ab12cd34. Esa URL es el punto final al que su sistema envía la solicitud POST.

En la página «Crear webhook», en la que se pregunta «¿Qué activará este webhook?», se ha seleccionado la opción «Nada: ejecutarlo según una programación» y se indica que, a continuación, se abrirá la pestaña «Programación».
Para crear un webhook, lo primero es determinar qué lo activará. La respuesta configura la autenticación correspondiente; la opción «Nada: ejecutarlo de forma programada» abre a continuación la pestaña «Programación».
El editor de webhooks: el nombre y la autenticación a la izquierda; la ficha «Endpoint», con el estado, la URL del webhook y el ID del webhook, a la derecha; y, más arriba, las opciones «Vista previa en vivo», «Probar» y «Uso».
El editor de webhooks. Los ajustes se encuentran a la izquierda; la ficha «Endpoint», situada a la derecha, contiene la URL del webhook que debe facilitar al remitente y el ID del webhook que debe utilizar en Shopify Flow.

2. Elija cómo deben acreditar su identidad las personas que llaman

Abra el webhook y elija un método de autenticación. Consulte Autenticación para ver la comparación completa; a modo de resumen:

  • Token estático: adecuado para casi todo el mundo. Pulse el botón «Generar», copie el token, Envíelo en el encabezado X-Api-Key.
  • HMAC SHA-256: para remitentes que firman sus solicitudes (Stripe, GitHub y similares).
  • Ninguna: solo a modo de prueba. Cualquier persona que disponga de la URL puede activar su flujo de trabajo.

3. Indíquenos qué ámbitos le interesan

En «Configuración avanzada», asigne hasta cuatro campos de su payload JSON. Si su sistema envía:

La pestaña «Configuración avanzada», en la que los campos 1 a 4 están asignados a orderId, status, total y note
Configuración avanzada: asigne hasta cuatro valores del cuerpo de la solicitud. Estos se reciben en Shopify Flow como fieldOne a fieldFour.
json
{ "customer": { "email": "someone@example.com" }, "orderId": "1001" }

Asigne fieldOne a orderId y fieldTwo a customer.email; en las rutas anidadas se utilizan puntos. Encontrará toda la información en Asignación de la carga útil y variables de flujo.

4. Envíe una solicitud de prueba

Una invocación se ha abierto en «Historial» con sus encabezados de solicitud, su payload, su estado, su duración y sus identificadores
Tras una solicitud de prueba, la invocación aparece en el «Historial» junto con la payload que se recibió.
bash
curl -X POST https://your-app-url/webhook/ab12cd34 \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: your-token" \
  -d '{"orderId":"1001","customer":{"email":"someone@example.com"}}'

Abra «Historial». Debería ver la llamada con su estado, sus encabezados y su payload. Si no aparece, en Historial y resolución de problemas encontrará una lista con todos los motivos de rechazo.

5. Cree el flujo de trabajo de Shopify Flow

En «Shopify Flow», cree un flujo de trabajo que comience con el activador «Webhook Trigger».

  1. Añada el activador y haga clic en «Registrar eventos».
  2. Vuelva aquí, abra la invocación en «Historial» y pulse «Repetir». Shopify Flow tiene ahora un una payload real con la que trabajar: es mucho más sencillo que adivinar los nombres de los campos.
  3. Añada una condición: Webhook ID debe coincidir con el ID de su webhook (que aparece en la página del webhook). Cada flujo de trabajo de «Webhook Trigger» recibe eventos de todos sus webhooks, por lo que esto Es esta condición la que hace que el flujo de trabajo responda únicamente a esta.
  4. Añada sus acciones, utilizando {{fieldOne}} en {{fieldFour}}.
  5. Active el flujo de trabajo.
Shopify Flow
En Shopify Flow, seleccione «Seleccionar un activador», abra Workflow Webhooks y elija «Activador de webhook».
Se ha abierto el signo «+» situado debajo del paso «Activador de webhook», mostrando las opciones «Acción» y «Condición».
El símbolo «+» que aparece debajo de un paso ofrece los dos elementos que conforman un flujo de trabajo: una condición y una acción.
Condición de Shopify Flow: el ID del webhook es igual al ID de un webhook
El primer paso de cada flujo de trabajo: una condición basada en el ID del webhook, de modo que el flujo de trabajo solo se ejecute para este webhook.
El panel «Añadir una variable» de Shopify Flow para el activador Webhook, en el que se muestran «webhookId» y «fieldOne» a «fieldFour» con valores de ejemplo procedentes de una solicitud reciente
Lo que el activador le proporciona a su flujo de trabajo: el ID del webhook y sus cuatro campos asignados, que se muestran con los valores de una solicitud reciente.
Acción «Enviar correo electrónico interno» de Shopify Flow con «fieldOne» y «fieldTwo» en el asunto, y «fieldThree» y «fieldFour» en el cuerpo del mensaje
Utilice los campos asignados en cualquier lugar en el que una acción de Shopify Flow admita una variable; en este caso, en el asunto y el cuerpo de un correo electrónico interno.
El flujo de trabajo final: activador de webhook, una condición basada en el ID del webhook y, a continuación, envío de un correo electrónico interno en la rama «True».
El flujo de trabajo final: activador, condición basada en el ID del webhook y, a continuación, su acción en la rama «True».

6. Póngase en marcha

Configure su sistema real para que apunte a la URL del webhook. Compruebe las primeras llamadas en el historial para asegurarse de que llegan y se procesan correctamente.

Si su remitente vuelve a intentarlo al agotarse el tiempo de espera, active la opción Protección contra entregas duplicadas (No permitir reintentos) para que un reintento no ejecute su flujo de trabajo dos veces.

La página «Webhooks», en la que se muestran seis webhooks, cada uno con su recuento de invocaciones, la autenticación y una indicación de si está «Activado» o «Desactivado»
La página «Webhooks». Cada fila muestra la frecuencia con la que se ha activado el webhook, cómo se autentican los usuarios que lo activan y si está habilitado; el menú de la derecha permite habilitarlo, deshabilitarlo o eliminarlo.