Aller au contenu
Documentation

Les actions et les champs

Configurer une étape d'action — le catalogue, la forme de chaque réglage, la fiche visée, les grilles « champ → valeur » — et citer un champ ou une variable.

6 min de lecture Mise à jour le 10 novembre 2026

Le catalogue des actions

GET https://staging-api.docage.com/FlowActions rend chaque action qu'une étape peut exécuter : son Code (à écrire dans ActionCode), son libellé, le type de la fiche qu'elle produit, et ses réglages (Parameters) — pour chacun, son nom, sa nature (Kind), s'il est obligatoire, le type de fiche qu'il désigne et sa valeur par défaut. ConsumesCredits dit qu'une action consomme des crédits à chaque exécution. Le catalogue fait foi : lisez-le à chaque session plutôt que de recopier cette page.

La forme d'un réglage

Configuration est un dictionnaire « nom du réglage → valeur », et toute valeur est une chaîne. Sa forme dépend de la nature du réglage :

Kind Nature Forme de la valeur
0 Texte Texte libre ; champs admis ({{Contact_FirstName}}).
1 Nombre Point décimal, sans séparateur de milliers.
2 Oui ou non true ou false ; absent, la valeur par défaut du catalogue (« envoyer » et « lancer » valent true).
5 Texte à champs Un texte où les champs {{…}} sont remplacés à l'exécution.
6 Type de fiche La clé du type (Contact, le code d'un objet personnalisé ou d'une famille de cartes).
7 Fiche ou modèle Son identifiant, cherché parmi les modèles du type quand le réglage désigne un modèle (IsTemplateReference).
8, 9 Étape ou motif d'échec d'un pipeline Son identifiant, pris dans le pipeline que désigne le réglage nommé par ScopeFromParameterName (GET https://staging-api.docage.com/Flows/References/Pipeline/{id}/Choices).
10 Grille « champ → valeur » Un tableau JSON, écrit dans la chaîne : [{"Field":"Contact_Statut","Value":"Client"},{"Field":"Contact_Note","ClearValue":true}]. ClearValue efface le champ ; une ligne absente ne le touche pas.
11 Variable du flux Le nom nu d'une variable déclarée (Total, jamais {{Total}}).
12 Fiche visée Voir ci-dessous.
13 Point de contrôle Le libellé exact d'un point que déclare l'étape du pipeline.
14 Relation <code>\|A ou <code>\|B : le code de la relation, et le côté de la fiche visée.
15 Propriétés de recherche Un tableau JSON de noms, écrit dans la chaîne : ["Email","LastName"].

Dans une grille, le champ est un chemin sans accolades (Contact_Statut) ; la valeur peut porter des champs. Le préfixe d'une ligne est la clé du type que l'étape crée ou modifie (Mail_, Transaction_) : un chemin qui vise une autre fiche est refusé. Une valeur s'écrit comme dans le JSON de l'API : une date en ISO 8601 (2026-12-31T10:00:00Z, jamais 31/12/2026), une énumération par le nom de son membre ou son nombre, un nombre avec un point. Une valeur qui ne se convertit pas, une propriété que l'étape n'a pas le droit d'écrire, font échouer l'étape en nommant le champ.

Les liens entre fiches se posent par l'action « Lier par une relation » (LinkRecords), jamais par une grille. Une liste à écrire (Mail_RecipientsToApply, AddToBoxIds…) ne s'applique qu'à la création d'une fiche, et se refuse sur une modification.

La fiche visée

Toute action qui agit sur une fiche porte, en tête de ses réglages, Target :

  • absent, ou Run : la fiche de l'exécution ;
  • PreviousStep : la fiche produite par l'étape sur laquelle celle-ci est branchée ;
  • l'Id d'une étape en amont : la fiche que cette étape a produite, fût-elle plusieurs étapes plus haut ;
  • Relation:<code>|A (ou |B) : la fiche liée à la fiche du flux par une relation — une seule ; aucune, ou plusieurs, font échouer l'étape ;
  • LinkOther : l'autre fiche du lien qui a déclenché le flux (déclencheur « lien posé ou retiré »).

Les champs de l'étape ({{Contact_LastName}}) désignent alors cette fiche. Une étape visée qui n'a rien produit — le plus souvent, une branche qui n'a pas été suivie — fait échouer l'étape.

Citer un champ ou une variable

Un chemin désigne une propriété par des segments séparés de _, le premier étant la racine ; un champ est un chemin entre doubles accolades, remplacé par sa valeur à l'exécution.

Forme Exemple Sens
Type_Prop Contact_LastName Une propriété de la fiche de l'exécution ; la racine est la clé du type (DEAL_Name pour une carte).
Type_Nav_Prop Contact_ParentCompany_Name En traversant une fiche liée.
Type_Liste[Nom]_Prop TransactionMember[Signataire]_Email Un élément d'une collection à nom convivial : un participant, un document d'un parcours.
Form_<champ> Form_Email La réponse à un champ d'un formulaire, dans un flux déclenché par son envoi.
Flow_FlowAction[n]_Output_Prop Flow_FlowAction[3]_Output_LastName La fiche produite par l'étape n.
Type_Relation[<code>\|A]_Prop Contact_Relation[5f2c…\|B]_Name Les fiches liées par une relation, leurs valeurs jointes.
{{Nom}} {{Total}} Une variable du flux.
{{Now}}, {{Today}} {{Today}} L'instant présent et le jour, en UTC.
[ADDDAYS(date, n)] [ADDDAYS({{Today}}, 7)] Une date décalée (aussi ADDMONTHS, ADDYEARS).
  • GET https://staging-api.docage.com/Flows/Fields/{type} rend les chemins d'un type dans cette grammaire, avec ce que chacun permet (lecture, écriture, obligatoire, nom convivial requis, énumération) ; en mode write ou writeCreation, il ne propose que ce qu'une étape peut écrire. GET https://staging-api.docage.com/Flows/{id}/Fields y ajoute les sorties des étapes et les variables du flux.
  • Un champ qui ne se résout pas reste visible dans le texte, jamais remplacé par du vide ; dans un filtre, il fait refuser l'étape.
  • Dans une valeur destinée à la machine (une ligne de grille, un nombre, une date, une adresse de webhook), un champ est rendu sans culture : les dates en ISO 8601 UTC, les nombres avec un point. Dans un texte destiné à une personne, il suit la langue de l'identité d'exécution. Une valeur insérée n'est jamais relue comme un champ.

Quelques actions à connaître

  • Envoyer un email (SendEmailFromTemplate) depuis un modèle ; pour l'adresser à RecipientEmail, le modèle doit porter un destinataire dynamique (PUT https://staging-api.docage.com/Mails/{id} avec "RecipientsToApply": [{ "PersonType": 2, "FriendlyName": "Destinataire", "RecipientType": 0 }]).
  • Créer et lancer un parcours (CreateTransactionFromTemplate) depuis un modèle, pour le contact de l'exécution ; sa grille surcharge ce que le modèle compose (Transaction_Name).
  • Rechercher une fiche, sinon la créer (FindOrCreateRecord) : retient la fiche la plus récemment créée dont chaque propriété de recherche vaut la valeur que la grille lui donne, et la crée sinon. Une propriété de recherche sans valeur, une valeur vide ou multiple, un champ qui ne se résout pas font échouer l'étape : la recherche ne s'élargit jamais.
  • Appeler un webhook (CallWebhook) : l'adresse est publique, en https:// ; un code hors 2xx est un échec, que la politique d'erreur et les nouvelles tentatives traitent.
  • Définir une variable (SetVariable), Envoyer une notification (NotifyUser), Mettre à la corbeille (DeleteEntity), Relancer ou Annuler un parcours en cours, Déplacer vers une étape (MoveToStage) une carte… — le catalogue les décrit toutes.