Les web webhooks entrants vous permettent d'envoyer des messages asynchrones dans Google Chat à partir d'applications autres que des applications de 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 à l'aide d'une application Chat, consultez Créer, lire, mettre à jour ou supprimer des messages.
Prérequis
Pour exécuter l'exemple de ce guide, vous avez besoin des éléments suivants:
Python
- Python 3.10.7 ou version ultérieure
- Un accès à Internet et à un navigateur Web
- Un compte Google Workspace avec accès à Google Chat
- 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
- Node.js et npm installés.
- Un accès à Internet et à un navigateur Web
- Un compte Google Workspace avec accès à Google Chat
- Espace Google Chat existant.
Apps Script
- Un accès à Internet et à un navigateur Web
- Un compte Google Workspace avec accès à Google Chat
- Espace Google Chat existant.
Java
- Java 11 ou version ultérieure
- Apache Maven
- Un accès à Internet et à un navigateur Web
- Un compte Google Workspace avec accès à Google Chat
- Espace Google Chat existant.
Créer un webhook
Pour créer un webhook, enregistrez-le dans l'espace Google Chat où vous souhaitez recevoir des messages, puis rédigez un script qui en envoie.
Étape 1: Enregistrez le webhook entrant
- Dans un navigateur Web, ouvrez Google Chat.
- Accédez à l'espace auquel vous souhaitez ajouter un webhook.
- En haut, à côté du titre de l'espace, cliquez sur la flèche vers le bas > Applications et intégrations.
- Cliquez sur Gérer les webhooks.
- Si cet espace contient déjà d'autres webhooks, cliquez sur Ajouter. Sinon, ignorez cette étape.
- Dans le champ Nom, saisissez "quickstart Webhook".
- Dans le champ URL de l'avatar, saisissez
https://developers.google.com/chat/images/chat-product-icon.png
. - Cliquez sur ENREGISTRER.
- Pour copier l'URL complète du webhook, cliquez sur Copier.
- Cliquez en dehors de la boîte de dialogue pour fermer la boîte de dialogue des 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é. Il envoie une requête create message à l'URL de 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
Dans votre répertoire de travail, créez un fichier nommé
quickstart.py
.Dans
quickstart.py
, copiez et collez le code suivant: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
Dans votre répertoire de travail, créez un fichier nommé
index.js
.Dans
index.js
, copiez et collez le code suivant: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
Accédez à la page Apps Script.
Cliquez sur Nouveau projet.
Copiez et collez le code suivant:
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
Dans votre répertoire de travail, créez un fichier nommé
pom.xml
.Dans
pom.xml
, copiez et collez les éléments suivants:Dans votre répertoire de travail, créez la structure de répertoire
src/main/java
.Dans le répertoire
src/main/java
, créez un fichier nomméApp.java
.Dans
App.java
, copiez et collez le code suivant: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écutez 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 y répondre en ajoutant le paramètre threadKey
à l'URL du webhook. Chaque threadKey
est propre à l'application qui la définit. Si deux applications ou webhooks de chat différents définissent le même threadKey
, deux threads différents démarrent.
Démarrer un fil de discussion
Pour publier le premier message d'un thread avec un webhook, ajoutez les paramètres threadKey
et messageReplyOption
à 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 thread.
https://chat.googleapis.com/v1/spaces/SPACE_ID/messages?threadKey=ARBITRARY_STRING&messageReplyOption=REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD
Répondre à un fil de discussion
Pour envoyer un message à un thread de message existant, ajoutez les paramètres threadKey
et messageReplyOption
à l'URL du webhook définie sur la valeur utilisée pour démarrer le thread. Par exemple, l'envoi d'un message à l'URL suivante publie une réponse au fil de discussion où threadKey
est MY-THREAD
et messageReplyOption
est REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD
:
https://chat.googleapis.com/v1/spaces/SPACE_ID/messages?threadKey=MY-THREAD&messageReplyOption=REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD
Limites et considérations
Lorsque vous configurez des webhooks, tenez compte des limites et des points suivants:
Chaque webhook ne fonctionne que dans l'espace Chat dans lequel il est enregistré.
Vous ne pouvez pas publier de webhooks sur Google Workspace Marketplace.
Les webhooks ne sont pas des conversations. Ils ne peuvent pas répondre aux messages des utilisateurs ni aux événements Google Chat, ni y répondre.
Si seules les unités organisationnelles de votre domaine ont activé les applications de chat, 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 les applications de chat sont activées pour tous les utilisateurs.
Gérer les webhooks n'est disponible que depuis un navigateur Web. Les webhooks doivent donc être configurés à partir de l'application Web Chat. Vous ne pouvez pas configurer les webhooks depuis l'application mobile Chat.