Aller au contenu principal

Description du schéma JSON

Ce document décrit la structure du schéma JSON du module Intégrations.

Structure générale​

Le schéma JSON est un tableau d'objets. Chaque objet est soit un nœud, soit un onglet :

[
  {
    "label": "Hello World!",
    "id": "1f24387b252057fe",
    "type": "tab",
    "disabled": false
  },
  {
    "name": "run",
    "id": "b51ab819b83e1915",
    "type": "inject",
    "x": 46.96875,
    "y": 99.51171875,
    "z": "1f24387b252057fe",
    "wires": [
      [
        "bd07e1ff0aedba0b"
      ]
    ]
  },
  {
    "id": "2b524ca59e4ed633",
    "type": "debug",
    "name": "debug",
    "x": 610.05078125,
    "y": 98.59765625,
    "z": "1f24387b252057fe",
    "wires": []
  },
  {
    "name": "function",
    "func": "msg.payload = 'World'\n\nreturn msg;",
    "id": "bd07e1ff0aedba0b",
    "type": "function",
    "x": 229.62890625,
    "y": 98.8515625,
    "z": "1f24387b252057fe",
    "wires": [
      [
        "2e1172b330c69aeb"
      ]
    ]
  },
  {
    "id": "2e1172b330c69aeb",
    "type": "template",
    "name": "template",
    "x": 418.66796875,
    "y": 98.19140625,
    "z": "1f24387b252057fe",
    "syntax": "mustache",
    "template": "Hello {{payload}} !",
    "output": "str",
    "wires": [
      [
        "2b524ca59e4ed633"
      ]
    ]
  }
]

Paramètres principaux des nœuds​

La plupart des nœuds ont les paramètres communs suivants :

  • id (string) - identifiant unique du nœud
  • type (string) - type du nœud (par exemple, "inject", "function", "template")
  • name (string) - nom affiché du nœud
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel le nœud appartient
  • wires (array) - tableau de tableaux contenant les identifiants des nœuds auxquels la sortie est connectée

Nœuds système​

Nœud "tab" (onglet)​

Un nœud de type tab est un conteneur qui regroupe des nœuds et s'affiche comme un onglet dans l'interface.

Paramètres :

  • label (string) - nom affiché de l'onglet
  • id (string) - identifiant unique de l'onglet
  • type (string) - type du nœud (tab)
  • disabled (boolean) - indique si l'onglet est désactivé

Nœud "debug" (débogage)​

Un nœud de type debug affiche des messages dans le panneau de débogage.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type du nœud (debug)
  • name (string) - nom affiché du nœud
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel le nœud appartient
  • wires (array) - tableau des connexions de sortie

Connexions entre les nœuds​

Le paramètre wires définit les connexions entre les nœuds. Chaque élément du tableau correspond à une sortie du nœud et contient un tableau avec les identifiants des nœuds auxquels cette sortie est connectée.

Exemple :

"wires": [
  [
    "bd07e1ff0aedba0b"
  ]
]

Description des paramètres des nœuds​

Nœud "inject" (injecteur)​

Le nœud inject sert à créer des messages et à les envoyer manuellement dans le flux.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type du nœud (inject)
  • name (string) - nom affiché du nœud
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel le nœud appartient
  • wires (array) - tableau des connexions de sortie

Nœud "function" (fonction)​

Un nœud de type function permet d'exécuter du code JavaScript arbitraire.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type du nœud (function)
  • name (string) - nom du nœud
  • func (string) - code à exécuter
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel le nœud appartient
  • wires (array) - tableau des connexions de sortie

Nœud "template" (modèle)​

Un nœud de type template transforme les messages à l'aide de modèles.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type du nœud (template)
  • name (string) - nom du nœud
  • syntax (string) - syntaxe du modèle (mustache ou plain)
  • template (string) - modèle du message
  • output (string) - type de sortie (str pour du texte brut, json ou yaml)
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel le nœud appartient
  • wires (array) - tableau des connexions de sortie

Nœud "interval-node" (intervalle)​

Un nœud de type interval-node génère des messages à intervalles définis.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type du nœud (interval-node)
  • name (string) - nom du nœud
  • interval (number) - intervalle entre les messages, en minutes
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel le nœud appartient
  • wires (array) - tableau des connexions de sortie

Nœud "switch" (interrupteur)​

Un nœud de type switch achemine les messages vers différents chemins selon des conditions.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type du nœud (switch)
  • name (string) - nom du nœud
  • property (string) - propriété du message à vérifier
  • rules (array) - tableau des règles de routage
  • outputs (number) - nombre de ports de sortie
  • checkall (string) - vérifier toutes les règles (true ou false)
  • repair (boolean) - corriger les messages invalides
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel le nœud appartient
  • wires (array) - tableau des connexions de sortie

Nœud "split" (séparateur)​

Un nœud de type split divise les messages en plusieurs parties.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type du nœud (split)
  • name (string) - nom du nœud
  • property (string) - propriété du message à diviser
  • propertyType (string) - type de la propriété (msg, flow, global)
  • splt (string) - séparateur pour les chaînes
  • spltType (string) - type de séparateur (str, bin)
  • arraySplt (number) - taille des parties pour les tableaux
  • arraySpltType (string) - mode de découpage des tableaux (len, index)
  • stream (boolean) - mode de traitement en continu
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel le nœud appartient
  • wires (array) - tableau des connexions de sortie

Nœud "http in" (entrée HTTP)​

Un nœud de type http in crée des points de terminaison HTTP et reçoit les requêtes HTTP entrantes.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type du nœud (http in)
  • name (string) - nom du nœud (facultatif)
  • url (string) - chemin URL du point de terminaison
  • method (string) - méthode HTTP (get, post, put, delete, patch)
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel le nœud appartient
  • wires (array) - tableau des connexions qui traitent les requêtes

Nœud "http request" (requête HTTP)​

Un nœud de type http request envoie des requêtes HTTP sortantes.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type du nœud (http request)
  • name (string) - nom du nœud
  • url (string) - URL de la requête
  • method (string) - méthode HTTP (GET, POST, PUT, DELETE, etc.)
  • ret (string) - format de la réponse (obj, txt, bin)
  • headers (array) - tableau des en-têtes de la requête
  • paytoqs (string) - emplacement du payload (body, query)
  • useAuth (boolean) - utiliser l'authentification
  • authType (string) - type d'authentification (basic, bearer)
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel le nœud appartient
  • wires (array) - tableau des connexions qui traitent la réponse

Nœud "http response" (réponse HTTP)​

Un nœud de type http response envoie des réponses HTTP au client.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type du nœud (http response)
  • name (string) - nom du nœud
  • statusCode (number) - code de statut HTTP de la réponse
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel le nœud appartient
  • wires (array) - tableau des connexions (généralement vide)

Nœud "cms-events"​

Ce nœud permet de suivre les événements du module Events et de les injecter dans le flux.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type du nœud (cms-events)
  • name (string) - nom du nœud
  • eventMarker (string) - identifiant de l'événement
  • property (string) - propriété du message à traiter
  • targetType (string) - type de cible du traitement (msg, flow, global)
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel le nœud appartient
  • wires (array) - tableau des connexions pour la suite du traitement

Nœud "admin-api" (Admin API)​

Ce nœud permet d'interagir avec différentes API.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type du nœud (admin-api)
  • name (string) - nom du nœud
  • path (string) - chemin du point de terminaison de l'API
  • method (string) - méthode HTTP (post, get, put, delete)
  • operation (string) - identifiant de l'opération
  • data (string) - données de la requête au format JSON
  • wires (array) - tableau des connexions qui traitent la réponse

Nœud "telegram"​

Un nœud de type telegram envoie des messages via l'API Telegram Bot. Les champs sont décrits en détail sur la page du nœud telegram.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type du nœud (telegram)
  • name (string) - nom du nœud
  • botToken (string) - token du bot
  • chatId (string) - identifiant du chat
  • text (string) - texte du message
  • parseMode (string) - format du texte (none, Markdown, MarkdownV2 ou HTML)
  • replyMarkup (array) - rangées de boutons Inline ; chaque bouton a un text et un callbackData
  • callbackQueryId (string) - identifiant de la requête callback
  • showAlert (boolean) - afficher la notification dans une fenêtre modale
  • notificationText (string) - texte de la notification (avec showAlert: true)
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel le nœud appartient
  • wires (array) - tableau des connexions de sortie

Nœud "whatsapp"​

Un nœud de type whatsapp envoie des messages via l'API WhatsApp Business Cloud. Les champs sont décrits en détail sur la page du nœud whatsapp.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type du nœud (whatsapp)
  • name (string) - nom du nœud
  • phoneNumberId (string) - identifiant du numéro expéditeur
  • accessToken (string) - token d'accès
  • apiVersion (string) - version de l'API Graph (v20.0 par défaut)
  • action (string) - type de message (message ou template)
  • to (string) - numéro du destinataire
  • text (string) - texte du message (avec action: message)
  • templateName (string) - nom du modèle (avec action: template)
  • locale (string) - langue du modèle (avec action: template)
  • components (array) - paramètres du modèle ; chacun a un type (header ou body), un parameter_name et un text
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel le nœud appartient
  • wires (array) - tableau des connexions de sortie

Nœud "notification"​

Un nœud de type notification envoie une notification à partir d'un modèle d'événement du module Events. Les champs sont décrits en détail sur la page du nœud notification.

Paramètres principaux :

  • id (string) - identifiant unique du nœud
  • type (string) - type du nœud (notification)
  • name (string) - nom du nœud
  • eventId (number | null) - identifiant du modèle d'événement
  • variables (object) - valeurs des variables du modèle, indexées par leurs marqueurs
  • recipientsPath (string) - chemin vers le tableau des destinataires dans le message
  • x, y (number) - coordonnées du nœud dans l'espace de travail
  • z (string) - identifiant de l'onglet auquel le nœud appartient
  • wires (array) - tableau des connexions de sortie
Dernière mise à jour le