apprise

extern/apprise

Fork 0

mirror of https://github.com/caronc/apprise.git synced 2024-12-04 05:54:35 +01:00

Table of Contents

Google Chat Notifications

Syntax
Parameter Breakdown

Example

Google Chat Notifications

Source: https://chat.google.com/
Icon Support: No
Message Format: Markdown
Message Limit: 4000 Characters per message

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.

Example

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

Quick Links:

📣 Apprise Notification Services and URL Examples
💡 Apprise CLI Tool Help
⚙️ Apprise Configuration Help
🌎 Apprise API/Web Interface