Réponse

Le bloc Réponse est la dernière étape de votre workflow qui formate et envoie une réponse structurée aux appels API. C'est comme l'instruction « return » pour l'ensemble de votre workflow — il emballe les résultats et les renvoie.

Aperçu

Le bloc Réponse vous permet de :

Comment ça fonctionne

Le bloc Réponse finalise l'exécution du workflow :

1. Collecte des données - Rassemble les variables et les sorties des blocs précédents
2. Formatage de la réponse - Structure les données selon votre configuration
3. Définition des détails HTTP - Applique les codes d'état et les en-têtes
4. Envoi de la réponse - Renvoie la réponse formatée à l'appelant de l'API

Quand utiliser les blocs Réponse

• Points de terminaison API : lorsque votre workflow est appelé via API, les blocs Réponse formatent les données de retour
• Webhooks : renvoie une confirmation ou des données au système appelant
• Tests : visualisez les résultats formatés lors du test de votre workflow

Deux façons de construire des réponses

Mode constructeur (recommandé)

Interface visuelle pour construire la structure de réponse :

• Glisser-déposer des champs
• Référencer facilement les variables de flux
• Aperçu visuel de la structure de réponse

Mode éditeur (avancé)

Écrire du JSON directement :

• Contrôle total sur le format de réponse
• Prise en charge des structures imbriquées complexes
• Utiliser la syntaxe <variable.name> pour les valeurs dynamiques

Options de configuration

Données de réponse

Les données de réponse constituent le contenu principal qui sera renvoyé à l'appelant de l'API. Elles doivent être formatées en JSON et peuvent inclure :

• Des valeurs statiques
• Des références dynamiques aux variables de flux en utilisant la syntaxe <variable.name>
• Des objets et tableaux imbriqués
• Toute structure JSON valide

Code d'état

Définir le code d'état HTTP pour la réponse. Les codes d'état courants incluent :

En-têtes de réponse

Configurer des en-têtes HTTP supplémentaires à inclure dans la réponse.

Les en-têtes sont configurés sous forme de paires clé-valeur :

Exemples de cas d'utilisation

Réponse du point de terminaison API

Confirmation de webhook

Gestion des réponses d'erreur

Entrées et sorties

Références de variables

Utilisez la syntaxe <variable.name> pour insérer dynamiquement des variables de workflow dans votre réponse :

{
  "user": {
    "id": "<variable.userId>",
    "name": "<variable.userName>",
    "email": "<variable.userEmail>"
  },
  "query": "<variable.searchQuery>",
  "results": "<variable.searchResults>",
  "totalFound": "<variable.resultCount>",
  "processingTime": "<variable.executionTime>ms"
}

Bonnes pratiques

• Utilisez des codes d'état significatifs : choisissez des codes d'état HTTP appropriés qui reflètent précisément le résultat du workflow
• Structurez vos réponses de manière cohérente : maintenez une structure JSON cohérente pour tous vos points d'accès API afin d'améliorer l'expérience des développeurs
• Incluez les métadonnées pertinentes : ajoutez des horodatages et des informations de version pour faciliter le débogage et la surveillance
• Gérez les erreurs avec élégance : utilisez la logique conditionnelle dans votre workflow pour définir des réponses d'erreur appropriées avec des messages descriptifs
• Validez les références de variables : assurez-vous que toutes les variables référencées existent et contiennent les types de données attendus avant l'exécution du bloc de réponse