Webhook

Le connecteur Webhook vous permet d'écouter les événements de votre backend compatible avec les webhooks. Il est conçu pour être utilisé avec le déclencheur Webhook. Ce déclencheur reçoit des événements provenant d'applications SaaS tierces compatibles avec les événements de webhook. Il prend en charge 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 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 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 type spécial de compte Google 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 en savoir plus, consultez 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 au moment de configurer le connecteur.

Configurer le connecteur

Une connexion est propre à 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 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 Emplacements.

    2. Cliquez sur Suivant.
  4. Dans la section Détails de 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 la nouvelle instance de connexion.

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

      • Ils peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Ils doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Ils ne peuvent pas dépasser 49 caractères.
      • Pour les connecteurs qui acceptent les abonnements aux événements, les noms de connexion ne peuvent pas commencer par le préfixe "goog".
    4. Description : (Facultatif) Saisissez 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 est activé par défaut. Il est obligatoire pour le connecteur Webhook.
    7. (Facultatif) Cliquez 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, 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 appropriées.

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

    2. Emplacement du champ du type d'événement : champ obligatoire qui indique l'emplacement (en-tête, paramètre de requête ou corps de requête) où le type d'événement associé à la requête d'événement entrante sera présent.
    3. Nom du champ du type d'événement : champ obligatoire dans l'emplacement configuré. Il 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 indique que la requête concerne un événement "user.created".
    4. Sélectionnez Activer la connectivité privée pour la 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 aux événements.
    5. Saisissez la configuration de lettres mortes. Si vous configurez les 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 lettres mortes : ID du projet Google Cloud dans lequel vous avez configuré la file d'attente Pub/Sub de lettres mortes.
      2. File d'attente de lettres mortes : 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 d'écouteur.
  7. Cliquez sur Créer.

Utiliser la connexion Webhook dans une intégration

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

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

Demander de l'aide à la communauté Google Cloud

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

Étapes suivantes