Avec ActiveCampaign, vous pouvez utiliser des webhooks pour envoyer des mises à jour en temps réel sur votre contact et l’activité de la campagne à une source extérieure.
Prenez note
- Notez que lors de la création d’un webhook, l’application destinataire doit accepter les demandes POST et disposer d’une API. En outre, nous ne prenons en charge que l’envoi de demandes HTTPS sur le port HTTPS par défaut (port 443).
- ActiveCampaign n’accepte pas les webhooks entrants.
- Les charges utiles des webhooks ne peuvent pas être personnalisées. La spécification d’autorisation est limitée à l’URL et aux paramètres de l’URL
Qu’est-ce qu’un webhook ?
Les Webhooks sont des messages automatisés envoyés d’un système à un autre lorsqu’un événement spécifique se produit. Vous pouvez utiliser des webhooks pour envoyer des données à partir de votre compte ActiveCampaign afin de mettre à jour une base de données ou une application externe avec des activités de contact, de campagne, d’offre et d’objet personnalisé au fur et à mesure qu’elles se produisent.
Par exemple, vous pouvez créer un webhook pour envoyer des données à une base de données externe chaque fois qu’un enregistrement de contact est mis à jour, qu’un compte est ajouté, qu’une tâche d’offre est créée ou qu’un contact clique sur un lien dans votre e-mail.
Il existe deux types de webhook : Standard et Custom Object. La disponibilité de ces types de webhooks dépend du type de plan que vous avez souscrit. Par exemple, certains comptes peuvent avoir accès aux deux types de webhooks, tandis que d’autres n’auront accès qu’aux webhooks standard.
Types de webhooks
ActiveCampaign propose deux types de webhooks : Objet standard et Objet personnalisé.
Crochets web d’objets standard
La disponibilité de certains objets standard dépend de votre plan ActiveCampaign.
Vous pouvez utiliser Standard webhooks pour envoyer des données à une source tierce lorsqu’une action se produit.
Les webhooks d’objets standard comprennent les contacts, les offres, les comptes, les campagnes, les sites web et les événements SMS.
Voici une liste des actions disponibles pour déclencher un webhook standard :
- ajouté ou mis à jour
- Campagne - transférée, ouverte, partagée, commence à être envoyée
- Contact - ajout ou mise à jour dans votre ActiveCampaign, ajout, mise à jour ou suppression dans un compte de votre ActiveCampaign, ajout d’une note, ajout ou suppression d’un tag, ajout d’une tâche, désabonnement
- Offre - ajoutée ou mise à jour, note ajoutée, pipeline ajouté, étape ajoutée, tâche ajoutée ou complétée, type de tâche ajouté
- L’e-mail a rebondi
- Lien cliqué
- Liste ajoutée
- SMS - répondu, envoyé, désabonné
Webhooks personnalisés
Utilisez custom object webhooks pour envoyer des données à une source tierce lorsqu’une action se produit avec un objet personnalisé. Utilisez les webooks personnalisés pour envoyer des données à une source tierce lorsqu’une action se produit avec un objet personnalisé, y compris les objets personnalisés importés depuis une intégration tierce prise en charge et les objets personnalisés que vous créez à l’aide de l’API ou de la page "Gérer les données" de votre compte.
Pour les utilisateurs de Shopify et WooCommerce, des webhooks d'objets personnalisés sont disponibles pour :
- Commandes: créées, mises à jour, supprimées
- Produits: créés, mis à jour, supprimés
Où sont créés les webhooks
Il y a deux endroits où vous pouvez créer un webhook dans ActiveCampaign : Paramètres du développeur et Automatisation.
Paramètres du développeur sous Mes paramètres
Transmet des données à une source tierce chaque fois qu’une ou plusieurs actions/événements spécifiés sont réalisés.
Action d’automatisation du webhook
Transmet les données à une autre URL dès qu’un contact interagit avec l’action Webhook dans une automatisation.
Cette action ne fonctionne qu’avec les webhooks d’objets standard.
Apprenez à envoyer un webhook à partir d’une automatisation.
Options d'initiation du webhook
Vous trouverez ci-dessous les options de lancement de webhook :
- Initiée par un contact: Cette option exécute des crochets lorsqu'un contact est à l'origine de l'action. Par exemple, lorsqu'un contact ouvre une campagne
- Initiée par n'importe quel utilisateur : Exécute les crochets lorsqu'un administrateur du compte déclenche l'action. Par exemple, lorsqu'un contact est ajouté à partir de la zone d'administration
- Initiés par les processus du système : Dans ce cas, les crochets sont exécutés lorsque les systèmes automatisés exécutent l'action. C'est le cas par exemple lorsqu'un e-mail est rejeté
- Lancé par l'API: Exécuter les hooks lorsque l'appel à l'API provoque l'action. Par exemple, lors de l'ajout d'un contact à l'aide de l'appel API contact_add
Créer un webhook dans les paramètres du développeur
Avec cette configuration, vous pouvez choisir le type de webhook à créer.
- Cliquez sur "Paramètres" dans le menu de gauche.
- Cliquez sur le bouton "Gérer les Webhooks".
- Cliquez sur le bouton "Ajouter".
- Une fenêtre modale apparaît. Choisissez le type de webhook que vous souhaitez créer.
- Sur l’écran suivant, remplissez les champs pour créer votre webhook :
- Crochets web d’objets standard :
- Complétez les champs nom et URL. Le champ URL correspond à l’endroit où le webhook sera envoyé à lorsque l’action se produira
- Dans le menu déroulant "Type", sélectionnez l’action ou l’événement qui déclenchera l’exécution du webhook. Vous pouvez sélectionner plusieurs événements
- Sélectionnez l’endroit où l’action ou les actions doivent être initialisées à partir de.Par exemple, vous pouvez choisir si le webhook doit se déclencher à partir de l’action d’un contact ou de l’action d’un utilisateur de compte
- Sélectionnez la liste à laquelle le webhook doit être associé. Ce champ de liste n’apparaîtra que si le type de webhook nécessite une liste
- Cliquez sur le bouton « Enregistrer »
- App et webhooks personnalisés :
- Fournissez un nom pour votre webhook
- Cliquez sur le menu déroulant "Type" pour sélectionner l’action ou l’événement qui déclenchera l’exécution du webhook. Vous pouvez sélectionner plusieurs événements
- Fournir l’URL que le webhook doit envoyer à
- Cliquez sur le bouton « Enregistrer »
- Crochets web d'objets personnalisés pour le e-commerce :
- Indiquez le nom pour votre webhook
- Fournir l'URL que le webhook doit envoyer à
- Cliquez sur le menu déroulant "Type" pour sélectionner l’action ou l’événement qui déclenchera l’exécution du webhook. Vous pouvez sélectionner plusieurs événements
- Cliquez sur le bouton « Enregistrer »
- Crochets web d’objets standard :
Comment sont reçues les données d’un webhook
Les données que vous recevrez seront envoyées en tant que paramètre POST vers votre URL. Affichez une liste des champs qui seront envoyés dans votre webhook.
Si vous utilisez l'action d'automatisation webhook, vous pouvez trouver les données spécifiques envoyées ici.
ActiveCampaign garantit la livraison des webhooks au moins une fois. Cela signifie que nous pouvons parfois envoyer un webhook plus d'une fois pour un même événement.
Caractères et limites valides pour les webhooks
Vous pouvez utiliser des caractères alphanumériques, ainsi que les caractères spéciaux suivants dans votre URL de webhook :
"$-_.+!*’ (),".
Le nombre de caractères inclus dans une note ou dans un autre champ d’un webhook n’est pas limité.
Test de votre webhook
Pour tester votre webhook, cliquez sur le bouton « Envoyer des exemples de données » situé sur la page Paramètres > Developer > Webhooks de votre compte ActiveCampaign. Une fois le clic effectué, nous enverrons les données de test à l’URL spécifiée dans la barre d’URL de votre webhook.