Google Chat Notifications

Ce contenu n’est pas encore disponible dans votre langue.

Overview

Source: https://chat.google.com/
Image Support: No
Attachment Support: No
Message Character Limits:
- Body: 4000

Account Setup

For this to work correctly you a GSuite account (there are free trials if you don’t have one). You then need to create a Webhook; they can be done as follows:

Open Google Chat in your browser
Go to the room to which you want to add a bot.
From the room menu at the top of the page, select Manage webhooks.
Provide it a name and optional avatar and click SAVE
Copy the URL associated with your new webhook.
Click outside the dialog box to close.

When you’ve completed, you’ll get a URL that looks a little like this:

https://chat.googleapis.com/v1/spaces/AAAAkM/messages?key=AIzaSSjMm-WEfqKqqsHI&token=O7bnyri_WEXKcyFk%3D
                                      ^    ^              ^                  ^       ^                 ^
                                      |    |              |                  |       |                 |
                                     workspace             ... webhook_key...         ..webhook_token..

Simplified, it looks like this:

https://chat.googleapis.com/v1/spaces/WORKSPACE/messages?key=WEBHOOK_KEY&token=WEBHOOK_TOKEN

Now it’s important to note that while this Apprise plugin uses gchat://, you can also just use this URL exactly the way it was provided to you from Google when you copied and pasted. This is a perfectly valid Google Chat Apprise URL as well.

Syntax

Valid syntax is as follows:

https://chat.googleapis.com/v1/spaces/{workspace}/messages?key={webhook_key}&token={webhook_token}
gchat://{workspace}/{webhook_key}/{webhook_token}

Parameter Breakdown

Variable	Required	Description
workspace	Yes	The workspace associated with your Google Chat account.
webhook_key	Yes	The webhook key associated with your Google Chat account.
webhook_token	Yes	The webhook token associated with your Google Chat account.
thread	No	You can optionally specify a `ThreadKey` on the URL to focus it’s notifications there.

Global Parameters

Variable	Description
overflow	This parameter can be set to either `split`, `truncate`, or `upstream`. This determines how Apprise delivers the message you pass it. By default this is set to `upstream` 👉 `upstream`: Do nothing at all; pass the message exactly as you received it to the service. 👉 `truncate`: Ensure that the message will fit within the service’s documented upstream message limit. If more information was passed then the defined limit, the overhead information is truncated. 👉 `split`: similar to truncate except if the message doesn’t fit within the service’s documented upstream message limit, it is split into smaller chunks and they are all delivered sequentially there-after.
format	This parameter can be set to either `text`, `html`, or `markdown`. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored.
verify	External requests made to secure locations (such as through the use of `https`) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to `no`. By default it is set to `yes`.
cto	This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds.
rto	This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds.
emojis	Enable Emoji support (such as providing `:+1:` would translate to 👍). By default this is set to `no`. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case.
tz	Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like `America/Toronto`, or any other properly formated Timezone describing your area.

Examples

Send a Google Chat notification

# Assuming our {workspace} is AAAAkM
# Assuming our {webhook_key} is AIzaSSjMm-WEfqKqqsHI
# Assuming our {webhook_token} is O7bnyri_WEXKcyFk%3D

apprise -vv -t "Test Message Title" -b "Test Message Body" \
   gchat://AAAAkM/AIzaSSjMm-WEfqKqqsHI/O7bnyri_WEXKcyFk%3D

Remember, you can also just use the URL as it was provided to you when configuring your Webhook: Send a Google Chat notification

# Assuming our {workspace} is AAAAkM
# Assuming our {webhook_key} is AIzaSSjMm-WEfqKqqsHI
# Assuming our {webhook_token} is O7bnyri_WEXKcyFk%3D

apprise -vv -t "Test Message Title" -b "Test Message Body" \
   https://chat.googleapis.com/v1/spaces/AAAAkM/messages?key=AIzaSSjMm-WEfqKqqsHI&token=O7bnyri_WEXKcyFk%3D

Want to target a specific threadKey? Just do the following:

# Assuming our {workspace} is AAAAkM
# Assuming our {webhook_key} is AIzaSSjMm-WEfqKqqsHI
# Assuming our {webhook_token} is O7bnyri_WEXKcyFk%3D
# Assuming our {threadkey} is ABC

apprise -vv -t "Test Message Title" -b "Test Message Body" \
   gchat://AAAAkM/AIzaSSjMm-WEfqKqqsHI/O7bnyri_WEXKcyFk%3D/?thread=ABC