Consultez la liste des 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 compatible avec les webhooks.

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 des connecteurs (roles/connectors.admin)

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

Attribuez 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 Integrations (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 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 depuis le volet Résumé de l'intégration de dans la barre d'outils d'intégration.
    4. Cliquez sur Créer.

    La page de l'éditeur d'intégration s'affiche.

  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 webhook et placez-le dans l'éditeur d'intégration.

    6. Pour configurer le déclencheur de webhook, vous pouvez soit utiliser une connexion de webhook existante disponible dans Integration Connectors, soit 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 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 de webhook si l'abonnement aux événements est 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é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énements de connecteur :
    1. Region (Région) : sélectionnez la région de votre connexion webhook.
    2. Connexion:sélectionnez la connexion webhook que vous souhaitez utiliser.

      Application Integration n'affiche que les connexions de webhook actives et pour lesquelles un abonnement à un événement est activé.

    3. Type d'abonnement à un événement: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 un déclencheur de webhook à l'aide d'une nouvelle connexion

Pour configurer le déclencheur du 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é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 Create Connection (Créer une connexion) :
    1. Dans la section Emplacement, choisissez l'emplacement de la connexion.
      1. Région: sélectionnez un établissement 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 section 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 connexion) : saisissez le nom de 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 de 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 Event Subscription Details (Détails de l'abonnement à l'événement), procédez comme suit :
      1. Authentification de l'écouteur: sélectionnez un type d'authentification pour l'écouteur d'événements et saisissez les informations pertinentes.

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

      2. Event Type Field Location (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: ce champ obligatoire à l'emplacement configuré 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 du corps de la requête signifie 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 devez effectuer des étapes de configuration supplémentaires après avoir créé la connexion. Pour en savoir plus, consultez la section Connectivité privée pour les abonnements à des événements.
      5. Saisissez la configuration de lettre morte. 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 Pub/Sub de lettre morte.
        2. Sujet de lettre morte : le 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 d'authentification de votre connexion et de l'écouteur.
    5. Cliquez sur Créer.

Sortie du déclencheur

Le déclencheur du webhook prend quelques minutes pour terminer la configuration de l'abonnement à un événement. Vous pouvez afficher l'état de votre abonnement à un événement dans le volet de configuration du déclencheur, sous Détails de l'abonnement à un événement.

Le déclencheur du webhook indique l'état d'un abonnement à un événement selon les états suivants:

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

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

Variable de sortie du déclencheur

Pour chaque événement, le déclencheur de 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 charge utile du webhook de sortie.

Afficher les abonnements à des événements

Pour afficher et gérer tous les abonnements à des é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 aux événements pour 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 détails de l'abonnement à un événement.

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égrations pour ouvrir le volet de configuration du déclencheur.
  2. Cliquez sur Configurer le déclencheur de webhook.
  3. Procédez comme suit sur la page Éditeur de déclencheur d'événements de connecteur :
    1. Pour conserver l'abonnement à un é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 à l'événement, comme vous le souhaitez.
    3. Cliquez sur OK.

    4. Vous pouvez afficher les détails de la connexion et de l'abonnement aux événements mis à jour dans le volet de configuration du déclencheur, sous Détails de l'abonnement aux événements.