Aller au contenu principal

Trigger API Endpoint

Le trigger API Endpoint crée un endpoint HTTP qui peut recevoir des requêtes et déclencher un workflow.

Vue d'ensemble​

Ce type de trigger est idéal pour :

  • Créer des APIs REST
  • Recevoir des données depuis des applications externes
  • Créer des webhooks entrants personnalisés
  • Exposer des endpoints pour l'intégration avec d'autres systèmes

Configuration​

Options de base​

Lors de la création d'un trigger API Endpoint, vous devez configurer :

Méthode HTTP​

Sélectionnez la méthode HTTP acceptée :

  • GET : Pour récupérer des données
  • POST : Pour créer ou envoyer des données
  • PUT : Pour mettre à jour des données
  • PATCH : Pour modifier partiellement des données
  • DELETE : Pour supprimer des données

Path​

Le chemin de l'endpoint (optionnel) :

  • Exemple : /api/orders
  • Si vide, l'endpoint sera accessible à la racine du trigger
  • Le chemin complet sera : https://your-domain.com/{trigger-slug}/api/orders

Chemin personnalisé​

Option permettant de personnaliser le chemin du déclencheur, et d'y ajouter des paramètres d'url.

Exemple de réponse attendue​

Vous pouvez spécifier un exemple de réponse attendue pour documenter l'endpoint et faciliter l'intégration.

Authentification​

Vous pouvez configurer l'authentification de l'endpoint :

Aucune authentification​

L'endpoint est accessible publiquement (non recommandé pour la production).

API Key​

  • Configurez une clé API
  • Les requêtes doivent inclure cette clé dans les headers ou les paramètres

OAuth​

  • Configurez l'authentification OAuth
  • Les requêtes doivent inclure un token OAuth valide

Données reçues​

Lorsqu'une requête est reçue, le workflow reçoit les données suivantes dans le contexte :

{
  "method": "POST",
  "path": "/api/orders",
  "headers": {
    "content-type": "application/json",
    "authorization": "Bearer ..."
  },
  "query": {
    "param1": "value1"
  },
  "body": {
    "orderId": "12345",
    "items": [...]
  }
}

Exemple d'utilisation​

Scénario : Réception de commandes​

  1. Créer le trigger :

    • Type : API Endpoint
    • Méthode : POST
    • Path : /orders
    • Authentification : API Key

  2. Créer le workflow associé :

    • Le workflow reçoit les données de la commande
    • Traite la commande
    • Envoie une confirmation

  3. Déployer :

    • Déployez le trigger dans l'environnement de production
    • L'endpoint sera accessible à : https://your-domain.com/{trigger-slug}/orders

Bonnes pratiques​

  • Sécurité : Utilisez toujours une authentification en production
  • Validation : Validez les données reçues dans le workflow
  • Documentation : Documentez vos endpoints pour les utilisateurs
  • Versioning : Utilisez des paths avec version si nécessaire (ex: /v1/orders)

Prochaines étapes​