Consultez les connecteurs compatibles avec Application Integration.

Déclencheur de webhook

Preview — Webhook trigger

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Le déclencheur Webhook est un déclencheur d'événement de connecteur qui vous permet d'appeler une intégration en fonction de tous les événements du backend compatibles avec les webhooks. Le déclencheur de webhook reçoit des événements d'applications SaaS tierces compatibles avec la fonctionnalité d'événements webhook. Ce déclencheur est compatible avec plusieurs types d'authentification pour votre écouteur d'événements.

Important:Les connecteurs d'intégration sont un composant facturable de Google Cloud. Pour en savoir plus sur les coûts et les frais d'utilisation des connecteurs d'intégration, consultez la page Tarifs Integration Connectors.

Avant de commencer

Si vous prévoyez de créer ou de configurer une connexion pour le déclencheur Webhook, assurez-vous de disposer du rôle IAM (Identity and Access Management) suivant dans le projet:

• Administrateur des connecteurs (roles/connectors.admin)

Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le déclencheur Webhook:

• Demandeur Application Integration (roles/integrations.integrationInvoker)

Pour en savoir plus sur l'attribution d'un rôle à un compte de service, consultez la page Gérer l'accès aux comptes de service.

Ajouter le déclencheur de webhook

Pour ajouter un déclencheur Webhook à votre intégration, procédez comme suit:

1. Dans la console Google Cloud, accédez à la page Application Integration.

   Accéder à Application Integration

2. Dans le menu de navigation, cliquez sur Intégrations.

   La page Liste des intégrations s'affiche et liste toutes les intégrations disponibles dans le projet Google Cloud.

3. Sélectionnez une intégration existante ou cliquez sur Créer une intégration pour en créer une.

   Si vous créez une intégration :

   1. Saisissez un nom et une description dans le volet Créer une intégration.
   2. Sélectionnez une région pour l'intégration.
      Remarque : Le menu déroulant Régions ne répertorie que les régions provisionnées dans votre projet Google Cloud. Pour provisionner une nouvelle région, cliquez sur Activer la région. Pour en savoir plus, consultez la section Activer une nouvelle région.
   3. Sélectionnez un compte de service pour l'intégration. Vous pouvez modifier ou mettre à jour les informations du compte de service d'une intégration à tout moment dans le volet Récapitulatif de l'intégration de la barre d'outils d'intégration.
      Remarque:L'option permettant de sélectionner un compte de service ne s'affiche que si vous avez activé la gouvernance de l'intégration pour la région sélectionnée.
   4. Cliquez sur Créer.

   Cela entraîne son ouverture dans l'éditeur d'intégrations.

4. Dans la barre de navigation de l'éditeur d'intégrations, cliquez sur Déclencheurs pour afficher la liste des déclencheurs disponibles.
5. Cliquez sur l'élément Déclencheur de webhook et placez-le dans l'éditeur d'intégrations.

Pour configurer le déclencheur webhook, vous pouvez utiliser une connexion webhook existante disponible dans les connecteurs d'intégration ou en créer une à l'aide de l'option de création de connexion intégrée.

Configurer un déclencheur de webhook à l'aide d'une connexion existante

Vous pouvez configurer le déclencheur Webhook à l'aide d'une connexion Webhook existante dans les connecteurs d'intégration. Notez que le déclencheur Webhook est un déclencheur d'événement de connecteur. Vous ne pouvez donc utiliser qu'une connexion Webhook avec l'abonnement aux événements activé pour configurer le déclencheur.

Pour savoir comment configurer un déclencheur de webhook à l'aide d'une nouvelle connexion de webhook, consultez Configurer un déclencheur de webhook à l'aide d'une nouvelle connexion.

Pour configurer un déclencheur Webhook à l'aide d'une connexion Webhook existante, procédez comme suit:

1. Cliquez sur l'élément Déclencheur Webhook dans l'éditeur d'intégrations pour ouvrir le volet de configuration du déclencheur.
2. Cliquez sur Configurer un déclencheur.
3. Fournissez les informations de configuration suivantes sur la page Éditeur de déclencheur d'événement du connecteur :
   1. Région:sélectionnez la région de votre connexion Webhook.
   2. Connexion:sélectionnez la connexion Webhook que vous souhaitez utiliser.

      L'intégration d'applications n'affiche que les connexions Webhook actives pour lesquelles un abonnement aux événements est activé.

   3. Type d'abonnement aux événements:saisissez le type d'événement que vous souhaitez utiliser pour déclencher l'intégration.
   4. Compte de service: sélectionnez un compte de service disposant des rôles IAM requis pour le déclencheur Webhook.
4. Cliquez sur OK pour terminer la configuration du déclencheur et fermer la page.

Pour en savoir plus, consultez la documentation sur la connexion Webhook.

Configurer le déclencheur de webhook à l'aide d'une nouvelle connexion

Pour configurer le déclencheur Webhook à l'aide d'une nouvelle connexion Webhook, procédez comme suit:

1. Cliquez sur l'élément Déclencheur Webhook dans l'éditeur d'intégrations pour ouvrir le volet de configuration du déclencheur.
2. Cliquez sur Configurer un déclencheur.
3. Ignorez le champ Région.
4. Cliquez sur Connexion, puis sélectionnez l'option Créer une connexion dans le menu.
5. Procédez comme suit dans le volet Créer une connexion :
   1. Dans la section Emplacement, choisissez l'emplacement de la connexion.
      1. Région: sélectionnez un emplacement dans la liste.

         Les régions disponibles pour les connecteurs sont les suivantes :

         Pour obtenir la liste de toutes les régions disponibles, consultez la page Emplacements.

      2. Cliquez sur Suivant.
   2. Dans la section Détails de la connexion, procédez comme suit :
      1. Connecteur: sélectionnez Webhook dans la liste déroulante des connecteurs disponibles.
      2. Version du connecteur: sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
      3. Nom de connexion: saisissez un nom pour l'instance de connexion.

         Les noms de connexion doivent répondre aux critères suivants :

         • Les noms de connexion peuvent contenir des lettres, des chiffres ou des traits d'union.
         • Les lettres doivent être en minuscules.
         • Les noms de connexion doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
         • Les noms de connexion ne peuvent pas dépasser 49 caractères.
         • Pour les connecteurs compatibles avec l'abonnement aux événements, les noms de connexion ne peuvent pas commencer par le préfixe "goog".
      4. Description: saisissez éventuellement une description pour l'instance de connexion.
      5. Compte de service : sélectionnez un compte de service disposant des rôles requis.
      6. Abonnement aux événements: l'abonnement aux événements est activé par défaut et est obligatoire pour le connecteur webhook.
         Remarque : L'option Enable event subscription, entity and actions n'est pas compatible avec cette connexion.
      7. Vous pouvez également cliquer sur + Ajouter un libellé pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
      8. Cliquez sur Suivant.
   3. Dans la section Détails de l'abonnement aux événements, procédez comme suit :
      1. Authentication Listener (Authentification de l'écouteur) : sélectionnez un type d'authentification pour l'écouteur d'événements, puis saisissez les informations appropriées.

         Les types d'authentification suivants sont compatibles avec l'écouteur de webhook:

         • Aucune authentification
         • Authentification Google: assurez-vous que le compte de service dispose du rôle roles/connectors.listener dont le jeton d'accès est utilisé pour l'authentification.
         • Authentification par clé API
         • Authentification de base
      2. Emplacement du champ de type d'événement: champ obligatoire qui indique l'emplacement (en-tête, paramètre de requête ou corps de la requête) où le type d'événement associé à la requête d'événement entrante sera présent.
      3. Nom du champ de type d'événement: champ obligatoire dans l'emplacement configuré qui identifie le type d'événement associé à la requête d'événement entrante.

      {
      "event_type": "user.created",
      ...
      // other request fields
      ...
      }

      Dans l'exemple ci-dessus, le champ event_type du corps de la requête indique que la requête concerne un événement "user.created".
      4. Sélectionnez Activer la connectivité privée pour une connectivité sécurisée entre votre application backend et votre connexion. Si vous sélectionnez cette option, vous devrez effectuer des étapes de configuration supplémentaires après avoir créé la connexion. Pour en savoir plus, consultez la section Connectivité privée pour l'abonnement aux événements.
      5. Saisissez la configuration de la file d'attente de lettres mortes. Si vous configurez une lettre morte, la connexion écrit les événements non traités dans le sujet Pub/Sub spécifié. Saisissez les informations suivantes :
         1. ID de projet de boîte à lettres morte : ID du projet Google Cloud dans lequel vous avez configuré le sujet Pub/Sub de boîte à lettres morte.
         2. Sujet de lettre morte : sujet Pub/Sub dans lequel vous souhaitez écrire les détails de l'événement non traité.
      6. Cliquez sur Suivant.
   4. Vérifier: vérifiez vos informations de connexion et d'authentification de l'écouteur.
   5. Cliquez sur Créer.

Sortie du déclencheur

La configuration de l'abonnement aux événements avec le déclencheur Webhook prend quelques minutes. Vous pouvez consulter l'état de votre abonnement aux événements dans le volet de configuration du déclencheur, sous Détails de l'abonnement aux événements.

Le déclencheur Webhook indique l'état d'un abonnement à des événements à l'aide des états suivants:

• Creating: indique que le déclencheur s'abonne à l'abonnement aux événements.
• Active: indique que le déclencheur est correctement abonné à un abonnement d'événement.
• Error: indique qu'un problème est associé à l'abonnement aux événements configuré.

En plus de l'état de l'abonnement aux événements, la section Détails de l'abonnement aux événements affiche d'autres informations, telles que la région de la connexion, son nom, le nom de l'abonnement aux événements, etc.

Variable de sortie du déclencheur

Pour chaque événement, le déclencheur Webhook génère une variable de sortie ConnectorEventPayload que vous pouvez utiliser dans vos tâches en aval. La variable de sortie est au format JSON et contient le schéma de la charge utile du webhook de sortie.

Afficher les abonnements aux événements

Pour afficher et gérer tous les abonnements aux événements associés à une connexion dans Integration Connectors, procédez comme suit:

1. Accédez à la page Integration Connectors > Connections (Connecteurs d'intégration > Connexions).

   Accéder à la page "Connexions"

2. Cliquez sur la connexion pour laquelle vous souhaitez afficher les abonnements.
3. Cliquez sur l'onglet Abonnements aux événements.

   Tous les abonnements d'événements de la connexion s'affichent.

Modifier le déclencheur de webhook

Vous pouvez modifier un déclencheur de webhook pour modifier ou mettre à jour la configuration de la connexion et les informations d'abonnement aux événements.

Important:Lorsque vous modifiez un déclencheur Webhook, vous pouvez conserver l'abonnement aux événements précédemment configuré associé au déclencheur ou le supprimer. La suppression d'un abonnement à des événements affectera toutes les intégrations publiées qui l'utilisent.

Pour modifier un déclencheur de webhook, procédez comme suit:

1. Cliquez sur l'élément Déclencheur Webhook dans l'éditeur d'intégrations pour ouvrir le volet de configuration du déclencheur.
2. Cliquez sur Configurer le déclencheur Webhook.
3. Procédez comme suit sur la page Éditeur du déclencheur d'événement du connecteur :
   1. Pour conserver l'abonnement aux événements précédemment configuré, cliquez sur Conserver. Sinon, cliquez sur Supprimer.
      Avertissement:La suppression d'un abonnement à des événements affectera toutes les intégrations publiées qui l'utilisent. Cette tâche est irréversible.
   2. Mettez à jour la configuration de la connexion et les détails de l'abonnement aux événements si nécessaire.
   3. Cliquez sur OK.

Vous pouvez consulter les informations de connexion et d'abonnement aux événements mises à jour dans le volet de configuration du déclencheur sous Détails de l'abonnement aux événements.

Quotas et limites

Pour plus d'informations sur les quotas et les limites, consultez la section Quotas et limites.

Étape suivante

• Découvrez toutes les tâches et tous les déclencheurs.
• Découvrez comment tester et publier une intégration.
• En savoir plus sur la gestion des erreurs
• Découvrez les journaux d'exécution d'intégration.