Webhook

Le connecteur de webhook vous permet d'écouter les événements de votre backend qui sont compatibles avec les webhooks. Ce connecteur est conçu pour être utilisé avec le déclencheur Webhook. 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 est compatible avec plusieurs types d'authentification pour votre écouteur d'événements. Pour utiliser le déclencheur Webhook dans votre intégration, vous devez d'abord configurer un connecteur Webhook.

Avant de commencer

Avant d'utiliser le connecteur de webhook, effectuez les tâches suivantes:

  • Dans votre projet Google Cloud :
    • Activez les services suivants :
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Pour savoir comment activer des services, consultez la page Activer des services.

    • Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Un compte de service est un compte Google spécial destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour plus d'informations, consultez la section Créer un compte de service.

    Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer lors de la configuration du connecteur.

Configurer le connecteur

Pour configurer le connecteur, vous devez créer une connexion à votre source de données (système backend). Une connexion est spécifique à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

  1. Dans la console Cloud, accédez à la page Integration Connectors > Connections (Connecteurs d'intégration > Connexions), puis sélectionnez ou créez un projet Google Cloud.

    Accéder à la page "Connexions"

  2. Cliquez sur + Créer pour ouvrir la page Créer une connexion.
  3. Dans la section Emplacement, choisissez l'emplacement de la connexion.
    1. Région : sélectionnez un emplacement dans la liste déroulante.

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

    2. Cliquez sur Suivant.
  4. 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 les abonnements à des événements, les noms de connexion ne peuvent pas commencer par "goog" préfixe.
    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 est activé par défaut et est obligatoire pour le connecteur 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.
  5. 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. Event Type Field Name (Nom du champ de type d'événement) : champ obligatoire dans les identifiants d'établissement configurés. 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 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 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 l'abonnement aux événements.
    5. Saisissez la configuration 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 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 lettre morte : sujet Pub/Sub dans lequel vous souhaitez écrire les détails de l'événement non traité.
    6. Cliquez sur Suivant.
  6. Vérifier : vérifiez vos informations de connexion et d'authentification de l'écouteur.
  7. Cliquez sur Créer.

Utiliser la connexion Webhook dans une intégration

Une fois la connexion créée, elle devient disponible à la fois Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration via la tâche Connecteurs.

  • Pour savoir comment créer et utiliser la tâche Connecteurs dans Apigee Integration, consultez la section Tâche Connecteurs.
  • Pour découvrir comment créer et utiliser la tâche Connecteurs dans Application Integration, consultez la section Tâche Connecteurs.

Obtenir de l'aide auprès de la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étape suivante