Consultez les connecteurs compatibles avec Application Integration.

Déclencheur de webhook

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

Avant de commencer

Si vous envisagez de créer ou de configurer une nouvelle connexion pour le déclencheur de webhook, assurez-vous de disposer du rôle IAM (Identity and Access Management) suivant sur le projet:

  • Administrateur du connecteur (roles/connectors.admin)

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

Accordez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le déclencheur de 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 de 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. Elle répertorie 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 Create Integration (Créer une intégration).
    2. Sélectionnez une région pour l'intégration.
    3. Sélectionnez un compte de service pour l'intégration. Vous pouvez modifier ou mettre à jour les détails du compte de service d'une intégration à tout moment à partir du volet Integration summary (Résumé de l'intégration) dans la barre d'outils de l'intégration.
    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égration, cliquez sur Déclencheurs pour afficher la liste des déclencheurs disponibles.
  5. Cliquez sur l'élément Déclencheur du webhook et placez-le dans l'éditeur d'intégration.

    6. Pour configurer le déclencheur de webhook, vous pouvez utiliser une connexion de webhook existante disponible dans Integration Connectors ou créer une connexion de webhook à 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 de webhook à l'aide d'une connexion de webhook existante dans Integration Connectors. Notez que le déclencheur de webhook est un déclencheur d'événement de connecteur. Par conséquent, vous ne pouvez utiliser une connexion webhook qu'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 de webhook à l'aide d'une connexion de webhook existante, procédez comme suit:

  1. Cliquez sur l'élément Déclencheur de webhook dans l'éditeur d'intégration pour ouvrir le volet de configuration du déclencheur.
  2. Cliquez sur Configurer un déclencheur.
  3. Indiquez les informations de configuration suivantes sur la page Éditeur de déclencheurs d'événements de connecteur:
    1. Region (Région) : sélectionnez la région de votre connexion Webhook.
    2. Connection (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. Event subscription type (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 de webhook.
  4. Cliquez sur OK pour terminer la configuration du déclencheur et fermer la page.
Pour en savoir plus, consultez la documentation sur les connexions webhook.

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

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

  1. Cliquez sur l'élément Déclencheur de webhook dans l'éditeur d'intégration 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. Connection Name (Nom de la 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 63 caractères.
      4. Description: vous pouvez éventuellement saisir 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 sera activé par défaut et obligatoire pour le connecteur de webhook.
      7. Vous pouvez également cliquer sur + Ajouter une étiquette pour ajouter une étiquette à 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, effectuez les opérations suivantes:
      1. Authentification de l'écouteur: sélectionnez un type d'authentification pour l'écouteur d'événements et saisissez les informations appropriées.

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

      2. Event Type Field Location (Emplacement du champ "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 demande 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.
        4. {
"event_type": "user.created",
...
// other request fields
...
}
         Dans l'exemple ci-dessus, le champ event_type dans le corps de la requête signifie que la requête se rapporte à une "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 devez effectuer des étapes de configuration supplémentaires après avoir créé la connexion. Pour en savoir plus, consultez Connectivité privée pour l'abonnement à un événement.
      5. Saisissez la configuration de lettres mortes. Si vous configurez des lettres mortes, la connexion écrit les événements non traités dans le sujet Pub/Sub spécifié. Saisissez les informations suivantes:
        1. ID du projet de lettre morte : ID du projet Google Cloud dans lequel vous avez configuré le sujet de lettre morte Pub/Sub.
        2. Sujet de lettres mortes : sujet Pub/Sub dans lequel vous souhaitez écrire les détails de l'événement non traité.
      6. Cliquez sur Suivant.
    4. Vérification: vérifiez les informations de votre connexion et d'authentification de l'écouteur.
    5. Cliquez sur Créer.

Sortie du déclencheur

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

Le déclencheur du webhook indique l'état d'un abonnement à un événement. Les états suivants sont disponibles:

  • Creating : indique que le déclencheur s'abonne à l'abonnement aux événements.
  • Active: indique que le déclencheur a bien été abonné à un abonnement à un événement.
  • Error: indique un problème avec l'abonnement à un événement configuré.

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

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 contenant 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 à Integration Connectors > 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 changer ou mettre à jour la configuration de la connexion et les détails de l'abonnement aux événements.

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

  1. Cliquez sur l'élément Déclencheur de webhook dans l'éditeur d'intégration pour ouvrir le volet de configuration du déclencheur.
  2. Cliquez sur Configurer un déclencheur de webhook.
  3. Procédez comme suit sur la page Éditeur de déclencheurs d'événements de connecteur:
    1. Pour conserver l'abonnement à l'événement configuré précédemment, cliquez sur Conserver, sinon cliquez sur Supprimer.
    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.

    4. 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