Skip to main content
Google Chat logo
  • Category: productivity
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 46
  • Triggers: 0
  • Slug: GOOGLE_CHAT
  • Version: 20261101_00

Tools

Slug: GOOGLE_CHAT_COMPLETE_IMPORTCompletes the import process for an import-mode Google Chat space and makes it visible to users. Use this action at the end of a data migration into Google Workspace, after all messages and memberships have been imported into a space that was created with importMode: true. Requires user authentication with domain-wide delegation (service-account flow) and the chat.import OAuth scope. Cannot be called with regular user OAuth.

Input Parameters

string
required
Required. Resource name of the import-mode space to finalize. Format: spaces/{space}. The space must have been created with importMode: true and the import must be complete before calling this.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_CREATE_CUSTOM_EMOJICreates a custom emoji in Google Chat for use within a Google Workspace organization. An administrator must enable custom emojis for the organization.

Input Parameters

object
required
The image payload for the custom emoji.
string
required
User-provided name for the emoji. Must be unique within the organization. Must start and end with colons (:), contain only lowercase letters, numbers, hyphens, and underscores. Example: ‘:party-emoji:‘

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_CREATE_MEMBERCreates a membership for a user, Chat app, or Google Group in a space. When creating a membership, if the member has auto-accept turned off, they’re invited and must accept the invitation before joining. Use this action when you need to add a new member to a Google Chat space. This can be used to invite individual users, add Chat apps, or add Google Groups to a space. If the member requires acceptance, they will receive an invitation. Note: parent must be the resource name of a space that already exists - this action does not create one. To start a new direct message with a user, use GOOGLE_CHAT_SET_UP_SPACE instead, which creates the DM space and adds the member in one call. Note: App authentication cannot add users external to the Workspace organization, add Google Groups, or add Chat apps to a space.

Input Parameters

object
The member to add to the space (used in request body).
string
required
Required. The resource name of the space to create the membership in. Format: spaces/{space}.
object
Represents a Google Group in Google Chat.
boolean
Optional. When true, the method runs using the user’s Google Workspace administrator privileges. Requires the chat.admin.memberships scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_CREATE_MESSAGECreates a message with text or cards in an existing Google Chat space, up to 32,000 bytes, or replies to a thread. Named-thread replies default to failing if the thread is missing; use GOOGLE_CHAT_SET_UP_SPACE to create a direct-message space first.

Input Parameters

string
Plain-text body of the message. With user authentication, this is the only supported field. Maximum message size is 32,000 bytes. You can mention users by using ‘@user’ syntax.
string
required
Resource name of the space to create the message in. Format: ‘spaces/{space}’.
array
Rich card UI elements (bot authentication only). For user authentication, only text messages are supported.
string
Optional. A custom ID for the message. Lets Chat apps get, update, or delete the message without storing its system-assigned ID. Must start with client- and contain only lowercase letters, numbers, and hyphens (max 63 chars).
string
Optional. A unique request ID. Specifying an existing request ID returns the message created with that ID instead of creating a new one. A random UUID is recommended.
string
Client-generated thread key for threads created by the calling Chat app. Google Chat only uses the key when message_reply_option is set: with either option, the message joins the thread for this key, or starts a new thread if the key is unused. Without message_reply_option, every message starts a new thread even if the key was used before. This key is unique per Chat app. Do not combine with thread_name.
string
Resource name of an existing thread, including threads created by people or other Chat apps. Format: ‘spaces/{space}/threads/{thread}’. Use the thread.name returned by GOOGLE_CHAT_LIST_MESSAGES. Do not combine with thread_key. When message_reply_option is omitted, defaults to REPLY_MESSAGE_OR_FAIL so a missing thread does not start a new conversation.
string ("NOTIFICATION_TYPE_NONE" | "NOTIFICATION_TYPE_FORCE_NOTIFY" | "NOTIFICATION_TYPE_SILENT")
Notification behavior when a message is posted.
string ("REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD" | "REPLY_MESSAGE_OR_FAIL")
Whether to reply to an existing thread or fail if none exists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_CREATE_REACTIONCreates an emoji reaction on a Google Chat message. Use this action when you need to add an emoji reaction (like 👍, ❤️, or 🎉) to an existing message in a Google Chat space. Either emoji_unicode or emoji_custom_id is required, but not both. This action is useful for acknowledging messages, voting on ideas, expressing emotions in response to messages, or building interactive message features in Google Chat bots.

Input Parameters

string
required
Resource name of the message to react to. Format: ‘spaces/{space}/messages/{message}’.
string
Unicode emoji to use for the reaction (e.g., ’👍’, ‘❤️’, ’🎉’). Either emoji_unicode or emoji_custom_id is required.
string
Resource name of a custom emoji to use for the reaction. Format: ‘spaces/{space}/customEmojis/{custom_emoji}’. Either emoji_unicode or emoji_custom_id is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_CREATE_SECTIONCreates a custom section in Google Chat for organizing conversations in the navigation panel. Use when you need to create a new custom section to organize spaces and direct messages in the user’s Chat sidebar.

Input Parameters

string ("CUSTOM_SECTION")
required
Required. The type of the section to create. Only CUSTOM_SECTION can be created; DEFAULT_* sections are system-managed.
string
required
Required. The user identifier. Use ‘me’ for the authenticated user or a specific user ID.
string
required
Required. The section’s display name. Max 80 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_CREATE_SPACECreates a named space in Google Chat. The calling user is automatically added as a member and space manager. For a group chat or direct message, use GOOGLE_CHAT_SET_UP_SPACE instead. Use this action when you need to create a discoverable named space for team collaboration or project discussions. For group conversations without a named space, use GOOGLE_CHAT_SET_UP_SPACE. Note: If you receive the error ALREADY_EXISTS when creating a space, try a different displayName. The displayName must be unique within the organization.

Input Parameters

string
Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.
string ("SPACE")
required
The type of space to create. Must be SPACE. For GROUP_CHAT or DIRECT_MESSAGE, use the GOOGLE_CHAT_SET_UP_SPACE action instead.
string
A description of the space. Helps users understand the space’s purpose. Supports up to 150 characters.
string
required
Required. The display name of the space. Max 128 characters. Must be unique within the organization (an ALREADY_EXISTS error is returned if the name is taken).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_DELETE_CUSTOM_EMOJIDeletes a custom emoji from Google Chat. By default, users can only delete custom emojis they created. Emoji managers assigned by the administrator can delete any custom emoji in the organization. Use this action when you need to permanently remove a custom emoji that is no longer needed. This action is irreversible — once deleted, the custom emoji cannot be recovered.

Input Parameters

string
required
Resource name of the custom emoji to delete. Format: customEmojis/{customEmoji}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_DELETE_MEMBERRemoves a user, Google Group, or app membership from a Google Chat space using its membership resource name. The request can use Google Workspace administrator privileges when authorized. A membership that is not found is reported as an error.

Input Parameters

string
required
Resource name of the membership to delete. Format: spaces/{space}/members/{member}. You can get this value from the spaces.members.list response or from the spaces.get response.
boolean
When true, requests will be made using Google Workspace administrator privileges. The authenticated user must be a Google Workspace administrator. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_DELETE_MESSAGEDeletes a message from a Google Chat space; with user authentication, the force option can also delete its threaded replies. Deletion is irreversible, and permitted actions depend on the caller’s authentication and permissions.

Input Parameters

string
required
Resource name of the message to delete. Format: spaces/{space}/messages/{message}. Custom IDs from clientAssignedMessageId field are supported.
boolean
When true, deletes the message and all its threaded replies. When false, deletion fails if threaded replies exist. Only applies to user authentication. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_DELETE_REACTIONDeletes a reaction to a message. Use when you need to remove a reaction that was previously added to a message. Users can only delete their own reactions. This action is irreversible — once the reaction is deleted, it cannot be recovered.

Input Parameters

string
required
Required. The resource name of the reaction to delete. Format: spaces/{space}/messages/{message}/reactions/{reaction}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_DELETE_SECTIONDeletes a custom section from Google Chat by its ID. This action is irreversible — once a section is deleted, it cannot be recovered. If the section contains items (such as spaces), they are moved to Google Chat’s default sections and are not deleted. Use when you need to remove a custom section that is no longer needed.

Input Parameters

string
required
The user ID of the user who owns the section. Use ‘me’ for the authenticated user.
string
required
The unique ID of the section to delete. Section IDs can be obtained from list sections actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_DELETE_SPACEDeletes a named space from Google Chat. Always performs a cascading delete, which means that the space’s child resources like messages and memberships are also deleted. Use this action when you need to permanently remove a Google Chat space and all associated data. This action is irreversible — the space and all its messages and memberships cannot be recovered once deleted.

Input Parameters

string
required
Resource name of the space to delete. Format: spaces/{space}. Example: spaces/AAQATWyCO-g
boolean
When true, the method runs using the calling user’s Google Workspace administrator privileges. The requesting user must be a Google Workspace administrator. Requires the chat.admin.delete or chat.admin.delete.all OAuth scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_DOWNLOAD_MEDIADownloads the bytes of a Google Chat message attachment via the media API. Use this after get_attachment to fetch the actual file content for an attachment. The resource_name parameter is the attachmentDataRef.resourceName returned by get_attachment. Returns the downloaded file. The download endpoint adds ?alt=media automatically, which is required by Google to return raw bytes rather than the JSON Media resource.

Input Parameters

string
Optional override for the local filename of the downloaded file. If omitted, a filename is derived from the resource name.
string
required
Required. The resource name of the media to download. This is the attachmentDataRef.resourceName returned by get_attachment or by a message that includes an attachment. Example: spaces/AAAA/messages/BBBB.BBBB/attachments/CCCC (URL-encoded by the action).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_FIND_DIRECT_MESSAGEReturns the existing direct message space with the specified user. Use this action when you need to find an existing DM space with a particular user, such as when checking if a DM already exists before creating one or when you need the space resource name for subsequent operations. If no direct message space exists with the specified user, this action returns a NOT_FOUND (404) error. Note: This only finds existing DM spaces - it does not create a new one. To start a new DM (or safely get-or-create one), use the GOOGLE_CHAT_SET_UP_SPACE action instead.

Input Parameters

string
required
Required. The resource name of the user to find a direct message with. Format: users/{user}. You can use ‘me’ as the alias for the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_FIND_GROUP_CHATSFinds group chat spaces whose human memberships contain exactly the calling user and the specified users. Results are paginated.

Input Parameters

array
Resource names of all human users in the group chat. Max 49 users. Format: users/{user}
integer
Maximum number of spaces to return. Values range from 1 to 30, inclusive.
string
Page token for pagination. Use from a previous response’s nextPageToken.
string
The view type to determine how much information is returned per space. One of: SPACE_VIEW_UNSPECIFIED, SPACE_VIEW_RESOURCE_NAME_ONLY, SPACE_VIEW_EXPANDED

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_GET_ATTACHMENTGets the metadata of a Google Chat message attachment. Returns the attachment’s content type, filename, source, and references that can be used to download the file via the media API. To fetch the binary bytes of the attachment, pass the returned attachmentDataRef.resourceName to the download_media action. Requires Chat app authentication (the chat.bot scope) — this endpoint is not callable with regular user OAuth.

Input Parameters

string
required
Required. Resource name of the attachment. Format: spaces/{space}/messages/{message}/attachments/{attachment}.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_GET_CUSTOM_EMOJIReturns details about a custom emoji in Google Chat. Custom emojis are only available for Google Workspace accounts, and the administrator must turn custom emojis on for the organization. Use this action when you need to retrieve information about a specific custom emoji, such as its name, unique identifier, or temporary image URL. This is useful for displaying emoji details or verifying emoji existence before performing other operations. Note: The payload field is only populated when creating or updating custom emojis and is not returned when getting emoji details.

Input Parameters

string
required
Required. Resource name of the custom emoji. Format: customEmojis/{customEmoji} You can use the emoji name as an alias for {customEmoji}. For example, customEmojis/:example-emoji: where :example-emoji: is the emoji name for a custom emoji.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_GET_MEMBERReturns details about a membership in a space. Use this action when you need to retrieve information about a specific member’s relationship with a Google Chat space, including their role, state, and user details.

Input Parameters

string
required
Resource name of the membership to retrieve. Format: spaces/{space}/members/{member}.
boolean
When true, requests the membership using Google Workspace administrator privileges. Requires the calling user to be a Google Workspace administrator with the chat.admin.memberships.readonly scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_GET_MESSAGEReturns details about a specific message in a Google Chat space. Use this action when you need to retrieve the full content, sender information, thread details, and other metadata for a particular message. Requires user authentication with an appropriate Google Chat OAuth scope.

Input Parameters

string
required
Required. The resource name of the message. Format: spaces/{space}/messages/{message}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_GET_SPACERetrieves details of a specific Google Chat space, including its display name, description, membership count, threading state, and available configuration. Administrator access can be requested when authorized; some response fields depend on the scopes used.

Input Parameters

string
required
Required. Resource name of the space. Format: spaces/{space}.
boolean
When true, returns the space using Google Workspace administrator privileges. Requires the calling user to be a Google Workspace administrator with the chat.admin.memberships.readonly scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_GET_SPACE_EVENTReturns an event from a Google Chat space. The event payload contains the most recent version of the resource that changed. Use this action when you need to retrieve details about a specific space event, such as a new message, membership change, reaction, or space update. If the resource was modified after the event occurred, the server returns the updated resource in the event payload. Note: The permissionSettings field is not returned in the Space object of the Space event.

Input Parameters

string
required
Required. The resource name of the space event. Format: spaces/{space}/spaceEvents/{spaceEvent}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_GET_SPACE_NOTIFICATION_SETTINGGets the notification settings for a user in a specific space. Use when you need to retrieve the caller’s space notification setting, including whether notifications are muted and what type of notifications are enabled. Requires user authentication with the https://www.googleapis.com/auth/chat.users.spacesettings OAuth scope.

Input Parameters

string
required
Required. The user for which to retrieve notification settings. Use ‘me’ for the authenticated user, an email address like ‘user@example.com’, or a user ID like ‘123456789’.
string
required
Required. The space ID for which to retrieve notification settings. Format: spaces/{space_id}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_GET_SPACE_READ_STATEReturns details about a user’s read state within a space. Use this action when you need to identify which messages in a space have been read or unread by the user.

Input Parameters

string
required
Resource name of the space read state. Format: users/{user}/spaces/{space}/spaceReadState

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_GET_THREAD_READ_STATEReturns details about a user’s read state within a thread. Use this action when you need to identify which messages in a specific thread have been read or unread by the user.

Input Parameters

string
required
Resource name of the thread read state. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_LIST_CUSTOM_EMOJISLists custom emojis visible to the authenticated user in Google Chat. Use this action when you need to retrieve all custom emojis available in Google Chat for the authenticated user. This is useful for displaying available emojis, filtering by creator, or enumerating organization-specific custom emojis. Supports pagination via pageSize and pageToken parameters. By default, returns up to 25 emojis.

Input Parameters

string
Query filter for custom emojis. Supports creator(‘users/me’) or NOT creator(‘users/me’) to filter by creator.
integer
Maximum number of custom emojis to return. Default is 25, maximum is 200.
string
Page token for pagination. Use the nextPageToken from a previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_LIST_MEMBERSLists a page of memberships in a Google Chat space, with optional role or member-type filters and options to include Google Groups or invited members. Use the returned nextPageToken to fetch subsequent pages.

Input Parameters

string
Optional. A query filter. You can filter memberships by a member’s role (role) and type (member.type). To filter by role, set role to ROLE_MEMBER or ROLE_MANAGER. To filter by type, set member.type to HUMAN or BOT. You can also filter for member.type using the != operator. To filter by both role and type, use the AND operator. To filter by either role or type, use the OR operator. Either member.type = "HUMAN" or member.type != "BOT" is required when use_admin_access is set to true. Other member type filters will be rejected.
string
required
Resource name of the space to list memberships from. Format: spaces/{space}
integer
Maximum number of memberships to return. The service may return fewer values. If unspecified, at most 25 memberships are returned. Must be between 1 and 1000.
string
Token for pagination. Pass the nextPageToken from a previous call to retrieve the next page of results.
boolean
Optional. When true, also returns memberships associated with a Google Group, in addition to other types of memberships. If a filter is set, Google Group memberships that don’t match the filter criteria aren’t returned.
boolean
Optional. When true, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don’t match the filter criteria aren’t returned. Currently requires user authentication.
boolean
Optional. When true, the method runs using the user’s Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege. Requires either the chat.admin.memberships.readonly or chat.admin.memberships OAuth 2.0 scope. Listing app memberships in a space isn’t supported when using admin access.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_LIST_MESSAGESLists non-system messages from one Google Chat space, with creation-time or thread filtering and a next-page token. It does not search message text or filter by sender; use GOOGLE_CHAT_SEARCH_MESSAGES for text search. Declared OAuth requirements include a Chat messages scope and directory.readonly.

Input Parameters

string
Optional. A query filter. You can filter messages by date (create_time) and thread (thread.name). To filter by date, specify create_time with an RFC-3339 timestamp in double quotes, e.g. "2023-04-21T11:30:00-04:00". Use > for after, < for before, and combine two timestamps with AND for a time interval. To filter by thread, specify thread.name formatted as spaces/{space}/threads/{thread} (only one thread.name per query). Combine thread and date with AND. Invalid queries are rejected by the server with INVALID_ARGUMENT. Note: filtering by sender is NOT supported.
string
required
Required. Full resource name of the single space to list messages from, formatted as spaces/{space}. Pass the complete name returned by GOOGLE_CHAT_LIST_SPACES, not only the space ID.
string
Optional. How the list of messages is ordered. Supports create_time asc or create_time desc.
integer
Optional. Maximum number of messages to return. Defaults to 25, maximum is 1000.
string
Optional. Token from a previous GOOGLE_CHAT_LIST_MESSAGES call to retrieve the next page. Keep parent, filter, orderBy, showDeleted, and page_size the same as in the call that returned the token.
boolean
Optional. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_LIST_REACTIONSLists a page of emoji reactions on a specific Google Chat message. Results can be filtered by emoji type or user, and a page token can be used to retrieve subsequent pages.

Input Parameters

string
Query filter for reactions. For example, filter by emoji: ‘emoji.emoji=“\u00a1\u00a1”’
string
required
Resource name of the message in format ‘spaces/{space}/messages/{message}’
integer
Maximum number of reactions to return. Must be between 1 and 200. If not specified, returns all reactions.
string
Token for pagination. Use the nextPageToken from a previous response to get the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_LIST_SECTION_ITEMSLists all items (such as spaces) within a specified section of a user’s Google Chat. Use when you need to retrieve all items grouped under a section in Google Chat, or when implementing pagination to fetch all items across multiple pages. Sections can be system sections like ‘default-spaces’ or custom sections created by the user. Requires user authentication with the https://www.googleapis.com/auth/chat.users.sections.readonly (read-only) or https://www.googleapis.com/auth/chat.users.sections (full access) OAuth scope.

Input Parameters

string
required
Required. The user who owns the section. Use ‘me’ for the authenticated user, or a user ID like ‘111477653670961777027’.
string
Optional. A query filter. Currently only supports filtering by space. For example, space = spaces/{space}. Invalid queries are rejected with an INVALID_ARGUMENT error.
string
required
Required. The section ID. Common values include ‘default-spaces’, ‘default-apps’, ‘default-direct-messages’, or a custom section ID.
integer
Maximum number of items to return. If unspecified, defaults to 25. Maximum is 100.
string
Token for pagination. Use the nextPageToken from a previous response to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_LIST_SECTIONSLists all sections available to the authenticated user in Google Chat. Use this action when you need to retrieve all sections for organizing conversations in the navigation panel. Sections include custom sections created by the user and system sections like default direct messages, default spaces, and default apps. Requires user authentication with one of the following OAuth scopes: - https://www.googleapis.com/auth/chat.users.sections - https://www.googleapis.com/auth/chat.users.sections.readonly

Input Parameters

string
required
Required. The user identifier. Use ‘me’ for the authenticated user or provide a specific user ID.
integer
Optional. Maximum number of sections to return. Maximum value is 100.
string
Optional. Token for pagination. Use the nextPageToken value from a previous response to retrieve the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_LIST_SPACE_EVENTSLists events from a Google Chat space. Use when you need to retrieve historical events such as new messages, membership changes, or reactions from a specific Google Chat space. The filter parameter is required and must specify event type filters. Note: This action requires specifying event type filters in the filter parameter. Supported event types include message events (created, updated, deleted), membership events (created, updated, deleted), and reaction events.

Input Parameters

string
required
Required filter for space events. Use format: event_types:“EVENT_TYPE”. For multiple types, separate with OR. Examples: ‘event_types:“google.workspace.chat.message.v1.created”’, ‘event_types:“google.workspace.chat.membership.v1.created” OR event_types:“google.workspace.chat.membership.v1.deleted”’
string
required
Resource name of the space to list events from. Format: spaces/{space}. You can get this value from the spaces.list response or from the space URL.
integer
Maximum number of space events to return. Accepts values between 1 and 500. If not specified, defaults to 25.
string
Token for pagination. Use the nextPageToken from a previous response to retrieve the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_LIST_SPACESLists a page of Google Chat spaces the authenticated user belongs to, using the chat.spaces or chat.spaces.readonly OAuth scope. Group chats and direct messages are not listed until the first message is sent.

Input Parameters

string
Optional. Query filter for space type. Format: spaceType = “VALUE” where VALUE can be SPACE, GROUP_CHAT, or DIRECT_MESSAGE. Use OR to separate multiple types. Cannot be SPACE_TYPE_UNSPECIFIED.
integer
Optional. Maximum number of spaces to return. Defaults to 100, maximum is 1000. Values over 1000 are auto-adjusted to 1000.
string
Optional. Token from previous list spaces call to retrieve the next page. Must match the original call’s filter value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_MOVE_SECTION_ITEMMoves a space from one section to another in Google Chat. Use when organizing spaces into different sections, such as moving a space from the default-spaces section to a custom user-created section. The action updates the section membership of the specified space item.

Input Parameters

string
required
The item ID. Format: items/{item}
string
required
The user ID. Format: users/{user}
string
required
The section ID. Format: sections/{section}
string
required
The target section to move the item to. Must be the full resource name in the format users/{user}/sections/{section} — a bare section ID is rejected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_POSITION_SECTIONChanges the sort order of a section in the Google Chat sidebar. Use when you need to reorder sections in the sidebar. Either sortOrder (absolute position) or relativePosition (START/END) must be provided to specify the new position.

Input Parameters

string
required
The user ID or resource name. Format: users/{user}
string
required
The section ID or resource name. Format: sections/{section}
integer
The absolute position of the section in the list. Must be greater than 0. If greater than the number of sections, the section appends to the end.
string ("START" | "END")
Relative position options for section positioning.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_REPLACE_MESSAGEUpdates a Google Chat message using a field mask, with support for text, cards, attachments, and other supplied properties. It can request creation of a missing message using a client-assigned ID.

Input Parameters

string
required
Required. Resource name of the message to replace. Format: spaces/{space}/messages/{message}. Supports custom client-assigned IDs.
string
Plain-text message body. Supports link previews and @mentions. Newlines can be represented with \n.
array
List of interactive cards (max 32KB total). Each card contains sections with widgets. Use this for rich interactive messages instead of deprecated ‘cards’.
array
User-uploaded files to attach. Replaces all existing attachments.
string
required
Required. Comma-separated list of field paths to update. Use ’*’ for full replacement. Supported fields: text, attachment, cards, cardsV2, accessoryWidgets, quotedMessageMetadata.
boolean
If true and the message specified by ‘name’ does not exist, creates a new message using the specified messageId (requires clientAssignedMessageId). Defaults to false.
string
Plain-text description of cards for fallback in notifications and when cards cannot be displayed.
object
Metadata for quoting a message. Includes name, lastUpdateTime, quoteType, and optionally forwardedMetadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_SEARCH_MESSAGESSearches for messages across Google Chat spaces the caller has access to. Use this action to find messages by keyword, sender, space, attachment presence, or mentions, instead of paging through ListMessages for a single space. Excludes private messages, Chat app messages, messages from blocked users, and messages in muted spaces. Requires user authentication with one of the following core OAuth scopes: - https://www.googleapis.com/auth/chat.messages - https://www.googleapis.com/auth/chat.messages.readonly Some filters and FULL-view metadata require the additional scopes documented on their request fields. Display-name enrichment is best-effort and optional.

Input Parameters

string ("SEARCH_MESSAGES_VIEW_BASIC" | "SEARCH_MESSAGES_VIEW_FULL")
How much detail to include for each search result.
string
required
Required. A search query supporting free-text keywords and field filters. Filterable fields: create_time (only </>=, e.g. create_time >= "2024-01-01T00:00:00Z"), sender.name (= only, resource name of a user, e.g. users/123456789), space.name (= only), space.display_name (partial match with :, e.g. space.display_name:"Eng Showcase"; requires chat.spaces or chat.spaces.readonly), attachment (presence check with attachment:*), and annotations.user_mentions.user.name (: match). Advanced functions is_unread() (requires chat.users.readstate or chat.users.readstate.readonly) and has_link() are also supported. Combine different fields with AND.
string
Required fixed search root. Google only accepts spaces/-; restrict searches to specific spaces with space.name or space.display_name in filter.
string ("create_time desc" | "relevance desc")
Supported result ordering for message searches.
integer
Optional. Maximum number of results to return. Defaults to 25, maximum is 100.
string
Optional. Token from a previous SearchMessages call to retrieve the next page.
string ("MARKUP_SYNTAX_CHAT" | "MARKUP_SYNTAX_MARKDOWN")
Syntax used for the returned message formattedText field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_SEARCH_SPACESSearches Google Chat spaces using filters such as display name, customer, creation time, activity, history state, and space type. Searches can use administrator access across a Workspace organization or user access to spaces the caller belongs to.

Input Parameters

string
required
Required. A search query. Filterable fields: create_time, customer, display_name, external_user_allowed, last_active_time, space_history_state, space_type. Examples: customer = "customers/my_customer" AND space_type = "SPACE", display_name:"Project*", create_time > "2024-01-01T00:00:00Z".
string
How the list of spaces is ordered. Supported attributes: membership_count.joined_direct_human_user_count, last_active_time, create_time. Valid ordering operation values: ASC (ascending, default) and DESC (descending). Example: membership_count.joined_direct_human_user_count DESC.
integer
The maximum number of spaces to return. Service may return fewer than this value. Default and maximum are 100.
string
A page token from a previous SearchSpaces call. Provide to retrieve the next page.
boolean
Required by the API to be true. Runs the search using Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with one of the admin scopes (chat.admin.spaces or chat.admin.spaces.readonly).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_SET_UP_SPACECreates a Google Chat named space, group chat, human DM, or calling-app DM and can add initial members. The caller is added automatically. Named spaces require displayName. Group chats require at least two memberships. Human DMs require exactly one HUMAN membership. For a calling-app DM, set singleUserBotDm to true and omit memberships. An existing human DM is returned. Google groups can only join named spaces. This is the only action that creates DIRECT_MESSAGE or GROUP_CHAT spaces; CREATE_SPACE, CREATE_MESSAGE, and CREATE_MEMBER require an existing space. Requires user authentication with one of the following OAuth scopes: - https://www.googleapis.com/auth/chat.spaces - https://www.googleapis.com/auth/chat.spaces.create

Input Parameters

string
A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space.
string ("SPACE" | "GROUP_CHAT" | "DIRECT_MESSAGE")
required
Required. The type of space to create: SPACE for named spaces, GROUP_CHAT for group chats, or DIRECT_MESSAGE for 1:1 conversations.
string
The display name of the space. Required when spaceType is SPACE.
array
The Google Chat users or groups to invite. Up to 49 memberships are allowed. GROUP_CHAT requires at least two memberships, and a human DIRECT_MESSAGE requires exactly one HUMAN membership. Omit memberships when singleUserBotDm is true.
boolean
Set to true to create a DM between the calling user and the calling Chat app. Only valid with spaceType DIRECT_MESSAGE, and memberships must be omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_UPDATE_MEMBERUpdates a user’s membership role in a Google Chat space, such as changing between member and manager.

Input Parameters

string ("MEMBERSHIP_ROLE_UNSPECIFIED" | "ROLE_MEMBER" | "ROLE_MANAGER" | "ROLE_ASSISTANT_MANAGER")
required
Required. The new role for the member. Use ROLE_MEMBER for regular members, ROLE_MANAGER to make them a manager, or ROLE_ASSISTANT_MANAGER for assistant manager.
string
required
Required. Resource name of the space where the membership exists. Format: spaces/{space}
string
required
Required. Resource name of the member to update. Format: spaces/{space}/members/{member}
string
required
Required. The field paths to update, comma-separated if multiple. Currently the only supported field is ‘role’.
boolean
Optional. When true, the method runs using the user’s Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_UPDATE_MESSAGEUpdates a Google Chat message’s text, cards, or other supported properties using an update mask. With allowMissing enabled, it can create a message when the specified message is missing; permitted updates depend on authentication and permissions.

Input Parameters

string
required
Required. Resource name of the message. Format: spaces/{space}/messages/{message}. Supports custom client-assigned IDs.
string
Plain-text message body. Supports link previews and @mentions. Newlines can be represented with \n.
array
List of interactive cards (max 32KB total). Each card contains sections with widgets. Use this for rich interactive messages instead of deprecated ‘cards’.
array
User-uploaded files to attach. Attachments are appended to existing attachments.
string
required
Required. Comma-separated list of field paths to update. Use ’*’ for full replacement. Supported fields: text, attachment, cards, cardsV2, accessoryWidgets, quotedMessageMetadata.
boolean
If true and the message specified by ‘name’ does not exist, creates a new message using the specified messageId (requires clientAssignedMessageId). Defaults to false.
string
Plain-text description of cards for fallback in notifications and when cards cannot be displayed.
object
Metadata for quoting a message. Includes name, lastUpdateTime, quoteType, and optionally forwardedMetadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_UPDATE_SECTIONUpdates a section’s display name in Google Chat. This action uses patch semantics for partial updates. Use when you need to rename an existing custom section in Google Chat. Only sections of type ‘CUSTOM_SECTION’ can be updated. System sections (like ‘default-direct-messages’, ‘default-spaces’, ‘default-apps’) cannot have their display names modified. Requires user authentication with the ‘https://www.googleapis.com/auth/chat.users.sections’ scope.

Input Parameters

string
The user whose sections to update. Use ‘me’ to refer to the authenticated user. Format: ‘users/{user}’ or ‘me’ for the authenticated user.
string
required
The section ID to update. Format: ‘users/{user}/sections/{section}’. For example: ‘MTc3NTc5OTg0MTk4MzIwMTAxNA’.
string
required
Required. The field paths to update, comma-separated if multiple. Currently supported: ‘displayName’.
string
The new display name for the section. Only sections of type ‘CUSTOM_SECTION’ can be updated. Supports up to 80 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_UPDATE_SPACEUpdates an existing Google Chat space’s display name, description, guidelines, history state, or predefined permission settings using an update mask. It can request administrator access when authorized.

Input Parameters

string
Guidelines for the space. Max 5000 characters.
string
required
Required. Resource name of the space. Format: spaces/{space}
string
Description of the space. Max 150 characters.
string
required
Required. The field paths to update, comma-separated if multiple. Common values: displayName, spaceDetails (covers both description and guidelines), spaceHistoryState, predefinedPermissionSettings, permissionSettings. Note: to update description or guidelines, use spaceDetails in the update mask (both fields live under the spaceDetails object).
string
New display name for the space. Max 128 characters.
boolean
When true, the method runs using the user’s Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the chat.admin.spaces scope.
string ("HISTORY_OFF" | "HISTORY_ON")
Defines the space history state for messages.
string ("COLLABORATION_SPACE" | "ANNOUNCEMENT_SPACE")
Predefined permission settings for a space.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_UPDATE_SPACE_NOTIFICATION_SETTINGUpdates the notification settings for a user in a space. Use when you need to modify how a user receives notifications in a specific space, such as muting a noisy channel or changing the notification level to only important messages. Requires user authentication with the chat.users.spacesettings scope.

Input Parameters

string
required
Identifier for the user. Use ‘me’ to refer to the authenticated user.
string
required
Identifier of the space. Format: spaces/SPACE_ID.
string
required
Required. Comma-separated list of field paths to update. Supported: notification_setting, mute_setting.
string ("MUTE_SETTING_UNSPECIFIED" | "UNMUTED" | "MUTED")
Mute setting options for space notifications.
string ("NOTIFICATION_SETTING_UNSPECIFIED" | "ALL" | "MAIN_CONVERSATIONS" | "FOR_YOU" | "OFF")
Notification setting options for space notifications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_UPDATE_SPACE_READ_STATEUpdates a user’s read state within a space, used to mark messages as read or unread. Use this action when you need to programmatically mark a Google Chat space as read or update the user’s read position in a space. Note: To mark a space as unread, set lastReadTime to a value earlier than the latest message timestamp. To mark as read, set it to any value later than the latest message.

Input Parameters

string
required
Identifier for the user. Use ‘me’ to refer to the authenticated user.
string
required
Identifier of the space. Format: spaces/SPACE_ID.
string
required
Required. Comma-separated list of field paths to update. Supported: lastReadTime.
string
The timestamp when the user’s read state was last updated. When set to a time later than the latest message, the space appears as read. Format: RFC 3339 format (e.g., ‘2026-04-09T17:00:00.000Z’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_CHAT_UPLOAD_MEDIAUploads a file of up to 200 MB as an attachment to a Google Chat space using the multipart media upload endpoint; the returned attachment upload token can be used in a subsequent message. Requires user authentication and either the chat.messages or chat.messages.create scope.

Input Parameters

string
required
Required. Resource name of the Chat space in which the attachment is uploaded. Format: spaces/{space}.
string
Optional override for the filename sent in the upload metadata. If omitted, the FileUploadable’s name is used.
object
required
The file to upload. Maximum size 200 MB. Any MIME type accepted by the Google Chat media endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not