Liste des champs du Webhook

Créer des Webhooks

La création de Webhooks passe par les trois étapes suivantes :

• Créer un webhook.
• Associer un webhook à une règle de workflow.
• Tester l'intégration du webhook.

Pour créer un webhook

1. Accédez à Setup (Configuration) > Automation (Automatisation) > Actions > Webhooks.
2. Dans la page Webhooks, cliquez sur Configure Webhook (Configurer le Webhook).
3. Dans la page New Webhook (Nouveau Webhook), indiquez tous les paramètres nécessaires.
4. Cliquez sur Save (Enregistrer).

Reconnaître les valeurs de champs de fusion non pris en charge

Parfois, vous pouvez remarquer que les valeurs de champ de fusion que vous avez utilisés dans l'éditeur Value Description (Description de la valeur) de votre webhook affichent maintenant ${Unsupported_Field}. Voici quelques-unes des raisons pour lesquelles cela se peut se produire.

Champ personnalisé supprimé

Le champ de fusion dont vous avez inséré la valeur a été supprimé. Si l'éditeur Value Description (Description de la valeur) de votre webhook contient toujours la valeur du champ de fusion d'un champ supprimé, cette valeur affichera ${Unsupported_Field}.

Champ de recherche personnalisé supprimé

Le champ de recherche personnalisé dont vous avez inséré la valeur a été supprimé. Si l'éditeur Value Description (Description de la valeur) de votre webhook contient toujours la valeur du champ de fusion d'un champ de recherche supprimé, cette valeur affichera ${Unsupported_Field}.

Champ non répertorié dans la liste des Champs de fusion disponibles

Si vous avez utilisé la valeur de champ de fusion d'un champ qui n'est pas dans la liste des champs de fusion disponibles pour le module sélectionné, elle affichera ${Unsupported_Field}.

Par exemple, si vous insérez la valeur de champ de fusion ${Leads.Lead Id} dans l'éditeur Value description (Description de la valeur) du module Deals (Transactions), elle sera répertoriée en tant que champ de fusion non pris en charge.

Intégrations/Fonctions désactivées

Lorsqu'une fonction ou une intégration a été désactivée pour votre compte, les champs qui ont été créés dans le cadre de l'intégration ne seront pas non plus disponibles pour le compte après la désactivation. Si la valeur de champ de fusion d'un tel champ a été insérée dans l'éditeur Value Description (Valeur de la description), elle affichera ${Unsupported_Field}. Cela s'applique aux fonctions/intégrations suivantes.

• Intégration de Google AdWords : les champs Google AdWords qui ne sont plus disponibles ne seront pas pris en charge.
• Suivi des visiteurs (Intégration de Zoho SalesIQ) : les champs de Suivi des visiteurs qui ne sont plus disponibles ne seront pas pris en charge.
• Gestion des secteurs : les champs qui ne sont plus disponibles ne seront pas pris en charge.
• Multidevise : les devises qui ont été désactivées ne seront pas prises en charge.

Pour associer un webhook à une règle de workflow

1. Accédez à Setup (Configuration) > Automation (Automatisation) > Workflow Rules (Règles de workflow)
2. Dans la page Workflow Rules (Règles de workflow), cliquez sur Create Rule (Créer une règle).
3. Dans la page Create New Rule (Créer une règle), spécifiez les paramètres de la règle de workflow.
4. Sous Workflow Actions (Actions de workflow), sélectionnez Webhooks.
5. Dans la fenêtre contextuelle Call Webhook (Appeler un Webhook), sélectionnez le webhook et cliquez sur Associate (Associer).
6. Cliquez sur Save (Enregistrer).

Pour tester l'intégration du webhook

1. Ajoutez des données de test dans CRM en fonction de vos critères de règle de workflow.
2. Dans votre application, vérifiez les données reçues de Zoho CRM via notification webhook.
3. S'il y a une erreur ou une incohérence de données, modifiez vos paramètres de webhook dans Zoho CRM.
4. Poursuivez ce test jusqu'à obtenir les données requises de Zoho CRM dans votre Application.

Remarques importantes

• Vous pouvez associer jusqu'à 6 webhooks (1 action instantanée et 5 actions programmées) par règle de workflow.
• Vous pouvez transférer des données pour un maximum de 10 champs CRM depuis Zoho CRM vers des applications tierces à l'aide d'un webhook.
• Vous ne pouvez pas extraire des données depuis d'autres applications vers Zoho CRM en utilisant des webhooks.
• Vous devez mettre à jour le ticket d'API régulièrement, en fonction des limites des applications tierces.
• Vous ne recevrez aucune notification par e-mail si l'intégration du Webhook a cessé de fonctionner en raison d'un problème quelconque dans une API tierce.
• Dans les webhooks, nous autorisons un maximum de 10 000 caractères pour le format défini par l'utilisateur, tout en utilisant la méthode POST.
• S'il y a une défaillance dans le processus, Webhook enverra d'abord une notification, puis le système Zoho CRM enverra une deuxième notification après 15 min. Par la suite, le système n'enverra plus de notifications Webhook pour ce déclenchement de workflow particulier.
• Si vous dépassez le nombre maximum par jour, le système n'enverra pas les notifications Webhook restantes aux applications tierces et informera l'Administrateur de l'échec.
• Dans le champ URL to Notify (URL à notifier), si vous souhaitez spécifier un numéro de port, veuillez noter que seuls les numéros de port 80 ou 443 sont pris en charge.
• Zoho CRM offre la possibilité de sélectionner le format Date/Date Time (Date Heure) requis et Time Zone (Fuseau horaire) pendant la configuration des paramètres Webhook.
• Limites pour les Webhooks :
• Édition professionnelle - 10 000 appels/jour ou 100 appels/licence utilisateur (selon la valeur la plus basse).
• Édition Entreprise - 20 000 appels/jour ou 500 appels/licence utilisateur (selon la valeur la plus basse).

Scénario métier 1

Calculer les commissions de ventes dans l'application Zoho Creator lors de la conclusion d'une Opportunité dans Zoho CRM.

Objectif

Les responsables commerciaux et l'équipe Paie peuvent utiliser l'application Sales Commission (Commissions de ventes) pour calculer la rémunération à verser aux commerciaux selon une formule pré-définie par votre organisation (par exemple, 2 % fixes du contrat conclu ou du montant de la vente). Cette application vous permet de réduire les saisies manuelles, de minimiser les erreurs et de gagner du temps lors du calcul des commissions pour vos commerciaux. De plus, les commerciaux peuvent suivre leurs commissions mensuelles dans un emplacement central.

Prérequis

• Compte dans l'application Zoho Creator
• Autorisation d'accéder à l'API Zoho
• Maîtrise de Zoho Creator

Procédure

1. Créer l'application Sales Commission (Commissions de ventes) dans Zoho Creator (voir le tutoriel Zoho Creator sur la Création d'applications)
2. Configurer un webhook dans Zoho CRM
3. Mettre en place une règle de workflow
4. Tester l'intégration de votre webhook

Étape 1 : Créer l'application Sales Commissions (Commissions de ventes) dans Zoho Creator

Dans Zoho Creator, créez l'application Sales Commission (Commission de ventes) avec les champs suivants :

• Sales Rep (Commerciaux)
• Deal Name (Nom de la transaction)
• Customer Name (Nom du client)
• Opportunity Amount (Montant de l'opportunité)
• Type of Business (Type d'entreprise) : Nouvelle entreprise ou Entreprise existante
• Closing Date (Date de clôture)
• Sales Commission (Commission)

Pour créer une application dans Zoho Creator, consultez l'aide en ligne

Étape 2 : Configurer un Webhook

Sélectionnez les champs suivants depuis le module Deal (Transaction) en configurant les paramètres définis par l'utilisateur :

• Deal Name (Nom de la transaction)
• Closing Date (Date de clôture)
• Type
• Record Owner (Propriétaire de l'enregistrement)
• Amount (Montant)

Dans Webhook, spécifiez les informations suivantes :

URL à notifier :

1. https://creator.zoho.com/api/xml/write - méthode POST

Paramètres définis par l'utilisateur (XML ou JSON)

Paramètres personnalisés :

Paramètre	Description
authtoken*	Spécifiez un authtoken à partir de votre compte Creator. Consultez l'aide Creator pour plus de détails.
zc_ownername*	Indiquez le nom du propriétaire de l'application de votre compte Creator.

Étape 3 : Configurer une règle de workflow

Suivez ces étapes dans la page Workflow Rule (Règle de workflow) :

1. Paramétrez les critères de workflow sur :
   • Type : New Business (Nouvelle entreprise)
   • Étape : Closed Won (Transaction conclue et clôturée)
2. Cliquez sur Next (Suivant).
   
3. Sélectionnez « webhook » comme action instantanée.
4. Dans la fenêtre contextuelle Call Webhook (Appeler un Webhook), sélectionnez le webhook requis dans la liste et cliquez sur Associate (Associer).
5. Enregistrez la règle de workflow.

 

Associer un Webhook à une Règle de workflow

Étape 4 : Tester votre intégration

1. Ajoutez une transaction test dans CRM en paramétrant les champs Type et Stage (Étape) sur New Business (Nouvelle entreprise) et Closed Won (Transaction conclue et clôturée), respectivement. Lors de la saisie des données de test, vérifiez que Amount (Montant), Closing Data (Données de clôture), Record Owner (Propriétaire de l'enregistrement), Account Name (Nom du compte) et Deal Name (Nom de la transaction) sont également saisis.
2. Ouvrez votre application Sales Commission (Commission de ventes) dans Zoho Creator et vérifiez les données CRM. 
   Si vous n'avez reçu aucune donnée, modifiez la configuration du webhook et continuez les essais. Après un test réussi, supprimez les entrées de test et déployez cette intégration auprès de vos utilisateurs de CRM.

Scénario métier 2

Envoyer des alertes SMS aux clients et aux commerciaux.

Objectif

Le paiement d'un client est exigible aujourd'hui. Vous pouvez envoyer un SMS avec la date d'échéance du paiement, le nom du client et le montant du paiement à votre commercial en associant un webhook à une action programmée dans une règle de workflow.

Prérequis

• Compte dans le service de passerelle SMS
• Autorisation d'accéder aux règles de workflow

Procédure

1. Créer un compte dans le service de passerelle SMS
2. Configurer un webhook dans Zoho CRM
3. Mettre en place une règle de workflow
4. Tester l'intégration de votre webhook

Étape 1: Créer un compte dans le service de passerelle SMS

Dans votre service de passerelle SMS, créez un compte et trouvez ces informations pour configurer le webhook :

• Sales Rep (Commerciaux)
• Deal Name (Nom de la transaction)
• Customer Name (Nom du client)
• Opportunity Amount (Montant de l'opportunité)
• Type of Business (Type d'entreprise) : New Business (Nouvelle entreprise)
• Étape : Closed Won (Transaction conclue et clôturée)
• Payment Due Date (Date d'échéance du paiement) (champ personnalisé)

Actuellement, Zoho a établi un partenariat avec les fournisseurs de passerelle SMS suivants :

• Bulk SMS
• Clickatell
• Screen Magic
• Valueleaf
• Solutions Infini

Vous pouvez acheter des crédits SMS et des informations sur les API aux fournisseurs ci-dessus.

Étape 2 : Configurer un Webhook

Sélectionnez les champs suivants depuis le module Leads en configurant les paramètres définis par l'utilisateur :

• Nom de domaine de la passerelle SMS
• Nom d'utilisateur
• Jeton d'authentification

Dans un webhook, spécifiez les informations suivantes :

URL à notifier :

1. http://<Domain Name>/smsgateway/post - méthode POST

Paramètres définis par l'utilisateur (XML ou JSON)

Étape 3 : Configurer une règle de workflow

Suivez ces étapes dans la page Workflow Rule (Règle de workflow) :

1. Paramétrez les critères de workflow sur :
   • Type : New Business (Nouvelle entreprise).
   • Étape : Closed Won (Transaction conclue et clôturée).
   • Choisissez une Date de clôture.
2. Sélectionnez le webhook en tant qu'action programmée.
3. Enregistrez la règle de workflow.

Critères de la Règle de workflow

Associer un Webhook à une Règle de workflow

Étape 4 : Tester votre intégration

1. Ajoutez une transaction test dans CRM en paramétrant les champs Type et Payment Due Date (Date d'échéance du paiement) sur Existing Business (Entreprise existante) et Today (Aujourd'hui), respectivement. Lors de la saisie des données de test, vérifiez que Amount (Montant), Closing Data (Données de clôture), Record Owner (Propriétaire de l'enregistrement), Account Name (Nom du compte) et Deal Name (Nom de la transaction) sont également saisis.
2. Dans votre téléphone portable, vérifiez si vous avez reçu l'alerte SMS
   Si vous n'avez pas reçu de SMS, modifiez la configuration du webhook et continuez les essais. Après un test réussi, supprimez les entrées de test et déployez cette intégration auprès de vos utilisateurs de CRM.

---

Comprendre les codes d'erreur

Lorsque l'exécution d'un webhook échoue, l'un des messages d'erreur suivants s'affiche dans Zoho CRM :

Codes d'état HTTP

• 400 Bad Request (400 Demande incorrecte) : il manque souvent un paramètre requis.
• 401 Unauthorized - Aucun jeton d'authentification valide fourni.
• 402 Request Failed (402 Échec de la demande) : les paramètres étaient valides, mais la demande a échoué.
• 404 Not Found (404 Non trouvé) : l'élément demandé n'existe pas.
• 500, 502, 503, 504 Server errors - Un problème est survenu dans l'application tierce.
• Code d'erreur 1 : connexion au serveur API temporairement impossible. Vous devez vérifier les journaux de serveur API, les paramètres du pare-feu pour trouver nos requêtes envoyées depuis CRM.

Erreurs personnalisées

• Échec de processus interne - Lorsque le webhook n'est pas exécuté en raison d'erreurs dans le traitement du webhook.
• Limite journalière atteinte - Lorsque l'entreprise a atteint le seuil maximum pour la journée.
• Lorsque le webhook n'est pas exécuté parce que l'URL est vulnérable aux SSRF ou parce qu'une URL n'est pas valide.