Webhook

Le connecteur de webhook vous permet d'écouter des événements depuis votre backend. Ce connecteur est conçu pour être utilisé avec le déclencheur de webhook. Pour utiliser le déclencheur de webhook dans votre intégration, vous devez d'abord configurer un connecteur de 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. 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.
  5. 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.
  6. Vérification: vérifiez les informations d'authentification de votre connexion et de l'écouteur.
  7. Cliquez sur Créer.

Utiliser la connexion de 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 via la tâche "Connecteurs".

  • Pour découvrir comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez la page 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.

Étapes suivantes