Envoyer des messages à Google Chat avec des webhooks entrants

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Les webhooks entrants vous permettent d'envoyer des messages asynchrones dans Google Chat à partir d'applications autres que Chat. Par exemple, vous pouvez configurer une application de surveillance pour avertir le personnel d'astreinte sur Google Chat lorsqu'un serveur tombe en panne.

Pour savoir comment envoyer, mettre à jour ou supprimer de manière asynchrone un message dans un espace Chat avec une application Chat, consultez Créer, lire, mettre à jour ou supprimer des messages.

Schéma montrant comment les webhooks entrants envoient des messages à Google Chat

Conditions préalables

Pour exécuter l'exemple de ce guide, vous avez besoin des éléments suivants:

Python

  • Python 3.10.7 ou version ultérieure
  • Accès à Internet et à un navigateur Web
  • Un compte Google Workspace avec accès à Google Chat.
  • Un espace Google Chat existant.
  • La bibliothèque httplib2. Si nécessaire, exécutez la commande d'interface de ligne de commande (CLI) suivante pour installer la bibliothèque à l'aide de pip:

    pip install httplib2
    

Node.js

Apps Script

Java

Créer un webhook

Pour créer un webhook, enregistrez-le dans l'espace Google Chat où vous souhaitez recevoir des messages, puis écrivez un script qui en envoie.

Étape 1: Enregistrez le webhook entrant

  1. Ouvrez Google Chat dans un navigateur Web.
  2. Accédez à l'espace auquel vous souhaitez ajouter un webhook.
  3. En haut, à côté du titre de l'espace, cliquez sur la flèche vers le bas > Icône de gestion des webhooks Gérer les webhooks.
  4. Si cet espace contient déjà d'autres webhooks, cliquez sur Ajouter. Sinon, ignorez cette étape.
  5. Dans le champ Nom, saisissez "Quickstart Webhook".
  6. Dans le champ URL de l'avatar, saisissez https://developers.google.com/chat/images/chat-product-icon.png.
  7. Cliquez sur ENREGISTRER.
  8. Cliquez sur Copier pour copier l'URL complète du webhook.
  9. Cliquez en dehors de la zone pour fermer la boîte de dialogue "Webhooks entrants".

Étape 2: Écrivez le script webhook

L'exemple de script de webhook publie un message dans l'espace dans lequel le webhook est enregistré en envoyant une requête create message à l'URL du webhook. L'API Google Chat répond par une instance de Message.

Choisissez un langage ci-dessous pour obtenir des instructions spécifiques sur la création du script webhook:

Python

  1. Dans votre répertoire de travail, créez un fichier nommé quickstart.py.

  2. Dans quickstart.py, copiez et collez le code suivant:

    python/webhook/quickstart.py
    from json import dumps
    
    from httplib2 import Http
    
    
    def main():
        """Hangouts Chat incoming webhook quickstart."""
        url = 'https://chat.googleapis.com/v1/spaces/7D8la4AAAAE/messages?key=' \
              'AIzaSyDdI0hCZtE6vySjMm-WEfRq3CPzqKqqsHI&token=' \
              'HulDviWFMz6R5FW-GwlO4INCW1cZGDDExuWVaEbbr_g%3D'
        bot_message = {
            'text': 'Hello from a Python script!'}
        message_headers = {'Content-Type': 'application/json; charset=UTF-8'}
        http_obj = Http()
        response = http_obj.request(
            uri=url,
            method='POST',
            headers=message_headers,
            body=dumps(bot_message),
        )
        print(response)
    
    
    if __name__ == '__main__':
        main()
  3. Remplacez la valeur de la variable url par l'URL de webhook que vous avez copiée à l'étape 1: enregistrez le webhook entrant.

Node.js

  1. Dans votre répertoire de travail, créez un fichier nommé index.js.

  2. Dans index.js, copiez et collez le code suivant:

    nœud/webhook/index.js
    /**
     * Sends asynchronous message into Google Chat
     * @return{obj} response
     */
    function webhook() {
      const fetch = require('node-fetch');
      const webhookURL = 'https://chat.googleapis.com/v1/spaces/AAAAGCYeSRY/messages?key=AIzaSyDdI0hCZtE6vySjMm-WEfRq3CPzqKqqsHI&token=u9IG_MuTBXw-tnqupPrPNinY2spKFcRBDp6dSldGUAw%3D';
    
      const data = JSON.stringify({
        'text': 'Hello from a Node script!',
      });
      let resp;
      fetch(webhookURL, {
        method: 'POST',
        headers: {
          'Content-Type': 'application/json; charset=UTF-8',
        },
        body: data,
      }).then((response) => {
        resp = response;
        console.log(response);
      });
      return resp;
    }
    
  3. Remplacez la valeur de la variable webhookURL par l'URL de webhook que vous avez copiée à l'étape 1: enregistrez le webhook entrant.

Apps Script

  1. Accédez à la page Apps Script.

  2. Cliquez sur Nouveau projet.

  3. Copiez et collez le code suivant:

    apps-script/webhook/webhook.gs
    function webhook() {
      const url = "https://chat.googleapis.com/v1/spaces/AAAAGCYeSRY/messages";
      const options = {
        "method": "post",
        "headers": {
          "Content-Type": "application/json; charset=UTF-8"
        },
        "payload": JSON.stringify({
          "text": "Hello from Apps Script!"
        })
      };
      const response = UrlFetchApp.fetch(url, options);
      Logger.log(response);
    }
  4. Remplacez la valeur de la variable url par l'URL de webhook que vous avez copiée à l'étape 1: enregistrez le webhook entrant.

Java

  1. Dans votre répertoire de travail, créez un fichier nommé pom.xml.

  2. Dans pom.xml, copiez et collez les éléments suivants:

    java/webhook/pom.xml,
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0</modelVersion>
    
      <groupId>com.google.hangouts.chat.webhook</groupId>
      <artifactId>java-webhook-app</artifactId>
      <version>0.1.0</version>
    
      <name>java-webhook-app</name>
      <url>https://github.com/googleworkspace/hangouts-chat-samples/tree/main/java/webhook</url>
    
      <properties>
        <maven.compiler.target>11</maven.compiler.target>
        <maven.compiler.source>11</maven.compiler.source>
      </properties>
    
      <dependencies>
        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
            <version>2.9.1</version>
        </dependency>
      </dependencies>
    
      <build>
        <pluginManagement>
          <plugins>
            <plugin>
              <artifactId>maven-compiler-plugin</artifactId>
              <version>3.8.0</version>
            </plugin>
          </plugins>
        </pluginManagement>
      </build>
    </project>
  3. Dans votre répertoire de travail, créez la structure de répertoire src/main/java.

  4. Dans le répertoire src/main/java, créez un fichier nommé App.java.

  5. Dans App.java, copiez et collez le code suivant:

    java/webhook/src/main/java/com/google/hangouts/chat/webhook/App.java
    import com.google.gson.Gson;
    import java.net.http.HttpClient;
    import java.net.http.HttpRequest;
    import java.net.http.HttpResponse;
    import java.util.Map;
    import java.net.URI;
    
    public class App {
      private static final String URL = "https://chat.googleapis.com/v1/spaces/AAAAGCYeSRY/messages";
      private static final Gson gson = new Gson();
      private static final HttpClient client = HttpClient.newHttpClient();
    
      public static void main(String[] args) throws Exception {
        String message = gson.toJson(Map.of("text", "Hello from Java!"));
    
        HttpRequest request = HttpRequest.newBuilder(
            URI.create(URL))
            .header("accept", "application/json; charset=UTF-8")
            .POST(HttpRequest.BodyPublishers.ofString(message))
            .build();
    
        HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    
        System.out.println(response.body());
      }
    }
  6. Remplacez la valeur de la variable URL par l'URL de webhook que vous avez copiée à l'étape 1: enregistrez le webhook entrant.

Étape 3: Exécuter le script webhook

Exécutez l'exemple en exécutant la commande suivante depuis votre répertoire de travail dans la CLI:

Python

  python3 quickstart.py

Node.js

  node index.js

Apps Script

  • Cliquez sur Run (Exécuter).

Java

  mvn compile exec:java -Dexec.mainClass=App

Lorsque vous exécutez l'exemple de code, le webhook envoie un message à l'espace dans lequel vous l'avez enregistré.

Démarrer un fil de discussion ou y répondre

Vous pouvez démarrer un fil de discussion ou répondre à un fil de discussion en ajoutant le paramètre threadKey à l'URL du webhook. Chaque threadKey est unique à l'application qui la définit. Si deux applications ou webhooks Chat différents définissent le même threadKey, deux fils de discussion différents démarrent.

Démarrer un fil de discussion

Pour publier le premier message d'un fil de discussion avec un webhook, ajoutez le paramètre threadKey à l'URL du webhook. Définissez threadKey sur une chaîne arbitraire, mais n'oubliez pas de l'indiquer : vous devrez la spécifier à nouveau pour publier une réponse au fil de discussion.

  https://chat.googleapis.com/v1/spaces/SPACE_ID/messages?threadKey=ARBITRARY_STRING

Répondre à un fil de discussion

Pour envoyer un message à un fil de discussion existant, ajoutez le paramètre threadKey à l'URL du webhook définie sur la valeur utilisée pour démarrer le fil de discussion. Par exemple, en envoyant un message à l'URL suivante, vous publiez une réponse au fil de discussion où threadKey est MY-THREAD :

  https://chat.googleapis.com/v1/spaces/SPACE_ID/messages?threadKey=MY-THREAD

Limites et considérations

Lorsque vous configurez des webhooks, tenez compte des limites et considérations suivantes:

  • Chaque webhook ne fonctionne que dans l'espace Chat dans lequel il est enregistré.

  • Vous ne pouvez pas publier de webhooks dans Google Workspace Marketplace.

  • Les webhooks ne sont pas des conversations. Ils ne peuvent pas répondre aux messages ni à la réception des messages ou des événements provenant de Google Chat.

  • Si vous n'avez activé que les applications de chat dans certaines unités organisationnelles de votre domaine, les webhooks entrants renvoient l'erreur suivante:

    {
      "error": {
        "code": 403,
        "message": "The caller does not have permission",
        "status": "PERMISSION_DENIED"
      }
    }
    
  • Les webhooks entrants fonctionnent dans les messages privés, mais uniquement lorsque tous les utilisateurs ont activé les applications de chat.

  • Étant donné que Icône de gestion des webhooks Gérer les webhooks n'est disponible que depuis un navigateur Web, vous devez configurer les webhooks depuis l'application Web Chat. Vous ne pouvez pas configurer de webhooks depuis l'application mobile Chat.