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.

Les blocs Réponse sont des blocs terminaux - ils mettent fin à l'exécution du workflow et ne peuvent pas se connecter à d'autres blocs.
Aperçu
Le bloc Réponse vous permet de :
Formater les réponses API : structurer les résultats du workflow en réponses HTTP appropriées
Définir les codes d'état : configurer les codes d'état HTTP appropriés en fonction des résultats du workflow
Contrôler les en-têtes : ajouter des en-têtes personnalisés pour les réponses API et les webhooks
Transformer les données : convertir les variables du workflow en formats de réponse adaptés aux clients
Comment ça fonctionne
Le bloc Réponse finalise l'exécution du workflow :
- Collecte des données - Rassemble les variables et les sorties des blocs précédents
- Formatage de la réponse - Structure les données selon votre configuration
- Définition des détails HTTP - Applique les codes d'état et les en-têtes
- 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 :
- 200 : OK - Réponse de succès standard
- 201 : Créé - Ressource créée avec succès
- 204 : Pas de contenu - Succès sans corps de réponse
- 400 : Mauvaise requête - Paramètres de requête invalides
- 401 : Non autorisé - Authentification requise
- 404 : Non trouvé - La ressource n'existe pas
- 422 : Entité non traitable - Erreurs de validation
- 500 : Erreur interne du serveur - Erreur côté serveur
- 502 : Mauvaise passerelle - Erreur de service externe
- 503 : Service indisponible - Service temporairement hors service
Le code d'état par défaut est 200 s'il n'est pas spécifié.
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 :
Clé | Valeur |
---|---|
Content-Type | application/json |
Cache-Control | no-cache |
X-API-Version | 1.0 |
Exemples de cas d'utilisation
Réponse du point de terminaison API
Scénario : renvoyer des données structurées à partir d'une API de recherche
- Le workflow traite la requête de recherche et récupère les résultats
- Le bloc de fonction formate et pagine les résultats
- Le bloc de réponse renvoie du JSON avec les données, la pagination et les métadonnées
- Le client reçoit une réponse structurée avec un statut 200
Confirmation de webhook
Scénario : accuser réception et traitement d'un webhook
- Le déclencheur de webhook reçoit les données du système externe
- Le workflow traite les données entrantes
- Le bloc de réponse renvoie une confirmation avec l'état du traitement
- Le système externe reçoit l'accusé de réception
Gestion des réponses d'erreur
Scénario : renvoyer des réponses d'erreur appropriées
- Le bloc de condition détecte un échec de validation ou une erreur système
- Le routeur dirige vers le chemin de gestion d'erreur
- Le bloc de réponse renvoie un statut 400/500 avec les détails de l'erreur
- Le client reçoit des informations d'erreur structurées
Entrées et sorties
Données de réponse : structure JSON pour le corps de la réponse
Code de statut : code de statut HTTP (par défaut : 200)
En-têtes : en-têtes HTTP personnalisés sous forme de paires clé-valeur
Mode : mode Constructeur ou Éditeur pour la construction de la réponse
response.data : le corps de réponse structuré
response.status : code de statut HTTP envoyé
response.headers : en-têtes inclus dans la réponse
response.success : booléen indiquant la réussite de l'exécution
Réponse HTTP : réponse complète envoyée à l'appelant de l'API
Terminaison du workflow : met fin à l'exécution du workflow
Accès : les blocs de réponse sont terminaux - aucun bloc subséquent
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"
}
Les noms de variables sont sensibles à la casse et doivent correspondre exactement aux variables disponibles dans votre workflow.
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