Ce que font les webhooks
Un webhook est un abonnement à un événement spécifique de la boutique. Lorsque cet événement se produit, Storeep envoie immédiatement les données de l'événement vers une URL que vous spécifiez (type API) ou une adresse e-mail que vous spécifiez (type E-mail). Les webhooks sont couramment utilisés pour les intégrations de suivi des commandes, les synchronisations CRM, les conversions de plateformes publicitaires et les notifications automatiques.
Pour gérer les webhooks, rendez-vous dans Paramètres → Webhooks.
Limites des webhooks
- Maximum 20 webhooks par boutique. Tenter d'en ajouter un 21e renvoie une erreur.
- Les webhooks sont listés du plus récent au plus ancien, paginés à 40 par page.
Créer un webhook
Cliquez sur Ajouter un nouveau webhook.
Interrupteur d'activation
Lorsqu'il est coché (par défaut), le webhook est actif dès sa sauvegarde. Les événements sont expédiés immédiatement. Décochez pour enregistrer le webhook dans un état désactivé sans recevoir d'événements. Vous pouvez activer ou désactiver un webhook à tout moment en le modifiant.
Nom
- Obligatoire.
- Maximum 50 caractères.
- Un libellé descriptif affiché dans la liste des webhooks. Exemple : Facebook CAPI, commande créée.
Type
Contrôle comment la charge utile de l'événement est livrée. Deux options :
- API : Storeep envoie une requête HTTP POST contenant les données de l'événement vers l'URL que vous spécifiez.
- E-mail : Storeep envoie un e-mail contenant les données de l'événement à l'adresse que vous spécifiez.
Événement
L'événement de boutique qui déclenche ce webhook. Trois événements sont disponibles :
- Session créée : se déclenche lorsqu'une nouvelle session de visiteur est créée dans votre boutique.
- Commande créée : se déclenche lorsqu'une nouvelle commande est passée.
- Commande mise à jour : se déclenche lorsque le statut ou les données d'une commande existante changent.
Format
Le format de données de la charge utile de l'événement. Actuellement une seule option :
- Json : la charge utile est envoyée sous forme de document JSON.
URL (type API uniquement)
- Obligatoire lorsque le type est API.
- Maximum 500 caractères. La limite élevée s'adapte aux URL contenant plusieurs segments de remplacement.
- Saisissez l'URL du point de terminaison sans le préfixe
https://. Il est ajouté automatiquement. Exemple :api.exemple.com/events/order. - Espaces réservés d'URL dynamiques : tout champ de la charge utile de l'événement peut être injecté dans l'URL en utilisant la syntaxe à double accolade :
{{nom_du_champ}}. Par exemple :https://exemple.com/postback?cid={{fbclid}}&payout={{order_total}}
Cela vous permet d'envoyer des données de conversion aux plateformes publicitaires directement depuis l'URL du webhook sans serveur proxy séparé. - Si la structure d'URL est invalide après la résolution des espaces réservés, vous recevrez une erreur de validation.
Adresse e-mail (type e-mail uniquement)
- Obligatoire lorsque le type est E-mail.
- Doit être une adresse e-mail valide, maximum 127 caractères.
Modifier un webhook
Cliquez sur n'importe quelle ligne de webhook pour ouvrir l'éditeur. Tous les champs sont modifiables. Le champ URL se pré-remplit uniquement si le type actuel est API ; le champ e-mail se pré-remplit uniquement si le type actuel est E-mail. Changer de type efface l'autre champ.
Activer et désactiver les webhooks
La case à cocher Activer en haut de l'éditeur contrôle si le webhook se déclenche. Le statut dans la liste affiche Activé ou Désactivé. Un webhook désactivé n'enregistre aucune livraison mais n'est pas supprimé, vous pouvez donc le réactiver ultérieurement sans le reconfigurer.
Colonnes de la liste des webhooks
- Nom : libellé du webhook avec la date de création.
- URL / E-mail : l'adresse de destination.
- Type : API ou E-mail.
- Événement : le nom de l'événement (Session créée, Commande créée ou Commande mise à jour).
- Format : Json.
- Statut : Activé ou Désactivé.
Supprimer un webhook
Sélectionnez un ou plusieurs webhooks et cliquez sur Supprimer les webhooks. C'est permanent et arrête toutes les livraisons futures pour cet abonnement.
Conseils et pièges
- Vous pouvez créer plusieurs webhooks pour le même événement, par exemple envoyer Commande créée à la fois à un CRM et à une plateforme publicitaire, chacun en tant qu'entrée de webhook séparée.
- Si votre point de terminaison nécessite une authentification, ajoutez les identifiants à la chaîne de requête de l'URL en utilisant un
{{espace_réservé}}provenant des données de l'événement, ou configurez un serveur proxy qui gère l'authentification avant de transmettre au vrai point de terminaison. - L'événement Session créée se déclenche pour chaque session de visiteur unique, ce qui peut être un volume élevé pour les boutiques populaires. Ne vous y abonnez que si votre point de terminaison peut gérer le débit.