Conseils, astuces et meilleures pratiques pour l'automatisation programmable

[TiphaineCuisset]

Avec le lancement de notre Hub Operations, nous voulions partager avec vous quelques conseils et astuces pour les toutes nouvelles fonctionnalités d'automatisation programmable et d'automatisation de la qualité des données. 

Nous tiendrons cette rubrique à jour et continuerons d'ajouter de nouveaux conseils, astuces et ressources pédagogiques afin que vous puissiez tout trouver en un seul endroit. N'hésitez pas à ajouter les vôtres dans la section des commentaires ci-dessous !

Conseil 1. Créez une bibliothèque de secrets

Avec l'action de code personnalisé, vous pouvez faire appel à d'autres services API dans le cadre de votre workflow. Afin de rendre cette opération aussi transparente que possible, nous avons également facilité le stockage sécurisé des secrets d'API qui vous permettent de vous authentifier auprès de ces services. Vous pouvez désormais stocker, gérer et référencer plusieurs secrets, y compris votre HAPIKEY, dans l'action Code personnalisé de HubSpot !

Pour ce faire, créez un workflow et ajoutez-y une action Code personnalisé. En haut du panneau se trouve une section Secrets où vous pouvez ajouter, modifier ou supprimer vos secrets. Vous pouvez choisir d'ajouter un secret dans l'action de code personnalisé ou en cliquant sur Gérer les secrets pour accéder à la modale de gestion des secrets.

Lorsque vous ajoutez des secrets, veillez à leur donner un nom descriptif afin de les différencier pour que les autres puissent les utiliser facilement. N'oubliez pas non plus que lorsque vous y faites référence dans votre code, vous devez respecter la casse (majuscule et minuscule).

Une fois que vous avez ajouté le secret, vous pouvez le sélectionner dans l'action de code personnalisé et voir comment l'utiliser dans votre code.

Bien que vous ne puissiez pas modifier le nom, vous pouvez modifier la valeur du secret. Toute modification mettra à jour tous les workflows qui y font référence. Il n'est donc pas nécessaire de parcourir chaque workflow à la recherche de références à ce secret.

Conseil 2. Ajoutez du contexte à votre code personnalisé 

L'action code personnalisé est l'une des actions les plus complexes et les plus flexibles que nous mettons à la disposition de nos utilisateurs. Nous voulons donc la rendre aussi accessible que possible à tous ceux qui utilisent des workflows.

Une façon de le faire est de laisser un commentaire sur votre action de code personnalisé dans le workflow. Lorsque vous ajoutez un code personnalisé à un workflow, il n'est pas toujours évident de savoir ce que fait cette action à partir de la vue du workflow ou pour tous ceux qui utilisent les workflows. En ajoutant des commentaires, vous pouvez simplifier cette tâche pour tout le monde.

Une autre façon de procéder consiste à décrire votre code. Il est ainsi plus facile pour vos pairs de le compléter, de le réviser, d'aider à le dépanner et de comprendre les actions qui ont lieu. Vous pouvez ajouter des commentaires dans votre code en utilisant "//" avant le commentaire, comme ceci :

Conseil n°3. Ajouter des messages personnalisés dans le registre pour faciliter le dépannage

Le dépannage d'un problème de fonctionnement peut être fastidieux et prendre beaucoup de temps. Une façon de vous faciliter la tâche, à vous et à votre équipe, est d'ajouter des messages personnalisés à votre code afin de clarifier ce qui se passe (ou ne se passe pas).

Vous pouvez ajouter des messages comme celui-ci :

Vous pouvez ensuite afficher ces messages dans les détails de l'événement, dans l'onglet Historique du workflow. Il sera ainsi plus facile pour quiconque de comprendre ce qui se passe dans un workflow utilisant du code personnalisé. Nous vous recommandons de travailler avec vos collègues qui gèrent ou examinent ces workflows afin de déterminer quels messages seraient les plus utiles.

Conseil 4. Définir les résultats

Une fois que vous avez écrit votre code personnalisé, vous pouvez définir un résultat (output) qui sera renvoyée et que vous voudrez utiliser plus tard dans votre workflow. Cela vous permet de générer des résultats que vous pouvez utiliser comme entrée dans une action ultérieure sans avoir à effectuer d'autres appels d'API. Cela peut vous aider à ne pas atteindre vos limites d'API avec HubSpot et avec d'autres services ou applications !

Pour ce faire, en bas du panneau Action du code personnalisé, vous pouvez sélectionner le type de données et fournir le nom du résultat.

Vous pouvez ensuite utiliser ce résultat dans une autre action, plus tard dans votreworkflow. Pour ce faire, ajoutez une nouvelle action et trouvez le résultat code personnalisé dans la liste déroulante Propriété :

Une fois que votre worklow est activé, vous pouvez voir les valeurs qui sont renvoyées pour ce résultat dans l'onglet historique du workflow. Cliquez simplement pour voir les détails de l'événement sur l'action du code personnalisé et regardez la section "Valeur de retour" (return value).