Comment connecter Vercel à Shopify Flow
Vercel envoie un Webhook lorsqu'un déploiement est créé, qu'il aboutit ou échoue, ou encore lorsqu'un projet ou un domaine est modifié. Workflow Webhooks transforme cet appel en un déclencheur Shopify Flow, afin que votre boutique puisse y réagir : attribuer une balise à un client, ajouter une note de commande, envoyer un e-mail interne, mettre à jour un métachamp… tout ce qu'Shopify Flow permet de faire.
Ce guide décrit l'ensemble du processus : Vercel envoie les données, Workflow Webhooks les reçoit et les vérifie, puis Shopify Flow effectue l'action requise. La signature HMAC de Vercel est vérifiée à chaque requête, de sorte que seul Vercel puisse lancer votre workflow.
Ce que vous pouvez construire
- Envoyez un e-mail à votre équipe lorsqu'un déploiement de boutique en ligne « headless » échoue.
- Après chaque déploiement réussi, veuillez enregistrer l'identifiant du déploiement en production dans un métachamp de la boutique.
- Lancez un workflow de mise à jour du cache ou de réindexation dès qu'un déploiement est prêt.
Exemples d'événements à envoyer : deployment.succeeded, deployment.error, project.created.
Avant de commencer
- Workflow Webhooks installé sur votre boutique Shopify.
- Shopify Flow installée, disponible gratuitement sur l'App Store de Shopify.
- Un compte sur Vercel disposant des autorisations nécessaires pour créer des webhooks.
Étape 1 - Créez le webhook sur Workflow Webhooks
- Accédez à Workflow Webhooks -> Webhooks -> Créer un webhook et attribuez-lui un nom que vous pourrez reconnaître dans Shopify Flow, tel que
Vercel events. - Dans la section « Authentification », sélectionnez HMAC.
- Dans la section « Fournisseur de signature », sélectionnez Vercel. L'application remplit automatiquement les champs « en-tête », « algorithme », « Payload signé » et « fenêtre de relecture » ; vous n'avez rien d'autre à configurer.
- Pour l'instant, ne renseignez pas le champ « secret » et cliquez sur « Enregistrer ». Copiez l'URL du webhook affichée sur la page.
Consultez la page Authentification pour connaître les autres modes d'authentification, et la page Mappage de la charge utile et variables de flux pour choisir les champs à transmettre à Shopify Flow.
Étape 2 - Ajouter le point de terminaison dans Vercel
Dans Vercel, ouvrez « Paramètres » -> « Webhooks » pour l'équipe ou le projet, créez un webhook avec l'URL que vous avez copiée, puis copiez la clé secrète qui s'affiche.
Comment trouver votre clé de signature Vercel
Le secret du webhook affiché lors de la création du webhook (ou le secret client de l'intégration).
La documentation de Vercel consacrée aux signatures de webhooks contient la formulation exacte et les captures d'écran correspondant à votre compte.
Collez cette clé secrète dans le champ « Secret » du webhook sur Workflow Webhooks, puis enregistrez. À partir de ce moment, chaque déploiement Vercel sera vérifié avant d'atteindre Shopify Flow.
Ce que cette vérification permet de contrôler
| Quoi ? | Valeur |
|---|---|
| En-tête de signature | x-vercel-signature |
| Emplacement de la signature | La valeur complète de l'en-tête |
| Ce qui est signé | {body} |
| Signature | HMAC-SHA1, codé en hexadécimal |
| Horodatage | Non utilisé par cet expéditeur |
| Protection contre la relecture | Aucune - cet expéditeur ne signe pas l'horodatage ; par conséquent, toute signature valide reste valide |
| Le secret | À utiliser sous forme de texte brut. Copiez-collez-le exactement tel que l'expéditeur l'a indiqué. |
Dans le payload signé, {body} correspond au corps brut de la requête, octet par octet.
Toute requête qui ne satisfait pas à l'une de ces conditions est rejetée avec le message 401, est enregistrée dans Historique et dépannage et ne déclenche jamais de workflow.
Étape 3 - Créer le workflow Shopify Flow
- Dans « Shopify Flow », créez un workflow et sélectionnez le déclencheur «Workflow Webhooks».
- Cliquez sur « Enregistrer les événements », puis envoyez un événement de test depuis Vercel (ou utilisez l'option « Envoyer un test » dans Workflow Webhooks) afin que Shopify Flow apprenne la structure de vos données.
- Chaque webhook dont vous disposez déclenche le même déclencheur de Shopify Flow ; veuillez donc ajouter une première condition sur l'identifiant du webhook afin de limiter ce workflow à Vercel uniquement. L'identifiant est indiqué sur la page du webhook.
- Ajoutez vos actions : identifiez un client, ajoutez une note, envoyez un e-mail interne, mettez à jour un métachamp.
Étape 4 - Testez-le de bout en bout
Déclenchez un événement réel dans Vercel. Dans Workflow Webhooks -> Historique, vous devriez voir l'appel avec le statut « Success ». Si la signature était incorrecte, vous obtiendrez à la place une entrée indiquant un échec avec le motif correspondant, et Vérification des webhooks signés explique le fonctionnement de l'outil de vérification de signature qui vous indique précisément quelle étape a échoué.
La signature ne correspond pas▾
Dans cette commande : le secret (cause la plus fréquente : un espace supplémentaire ou une clé provenant d'un environnement incorrect), le fait que l'expéditeur utilise le secret d'un autre point de terminaison, et le fait que quelque chose entre Vercel et l'application réécrive le corps de la requête. Les signatures portent sur les octets bruts ; par conséquent, un proxy qui reformate le JSON les invalide. Le testeur de signature sur la page du webhook affiche le texte exact qui a été signé.
Je reçois un code 401 à chaque requête▾
Vérifiez que l'authentification du webhook est configurée sur HMAC avec le fournisseur Vercel sélectionné, que le secret est renseigné et que Vercel envoie ses requêtes à l'URL exactement telle qu'elle apparaît dans l'application, y compris le code à la fin.
Rien n'apparaît dans l'historique▾
La requête n'est jamais arrivée. Vérifiez à nouveau l'URL dans Vercel et consultez le journal de transmission de Vercel pour connaître la réponse reçue. Un message 404 indique qu'un Webhook est incorrect ou a été supprimé ; un message 429 signifie que vous avez dépassé la limite d'appels de votre forfait - consultez Forfaits et utilisation.
The workflow runs for incorrect events▾
Chaque webhook de votre boutique déclenche le même déclencheur Shopify Flow. Ajoutez une condition sur l'identifiant du webhook comme première étape du workflow, ou affinez les événements que vous envoyez depuis Vercel.
Connexes
- Vérification des webhooks signés - tous les prestataires que nous vérifions, et comment décrire ceux que nous ne vérifions pas.
- Mappage de la charge utile et variables de flux - extraire les champs appropriés de la payload et les transférer dans Shopify Flow.
- Protection contre les livraisons en double - Que se passe-t-il lorsque Vercel tente à nouveau une livraison ?
- Historique et dépannage - le journal de chaque requête, avec possibilité de relecture.