Google Chat API integration for messaging and collaboration in Google Workspace
Completes 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.
Creates a custom emoji in Google Chat for use within an organization. Use this action when you need to add a custom emoji that can be used by members of your Google Workspace organization. The emoji will be available in Google Chat after creation. Note: Custom emojis are only available for Google Workspace accounts and require the administrator to enable custom emojis for the organization. This is a Developer Preview feature.
Creates a message in a Google Chat space. With user authentication, only text messages are supported. Maximum message size is 32,000 bytes. Use this action when you need to send a message to a Google Chat space or channel. You can reply to existing threads by providing a thread_key, or start a new conversation. Messages can mention users using '@username' syntax. Note: With user auth, only plain text messages are supported. Card-based messages require bot authentication.
Creates 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.
Creates 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.
Creates a named space or group chat in Google Chat. The calling user is automatically added as a member and space manager. Use this action when you need to create a new Google Chat space for team collaboration, project discussions, or group conversations. This action creates a named space that users can discover and join. Note: If you receive the error ALREADY_EXISTS when creating a space, try a different displayName. The displayName must be unique within the organization.
Creates 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: App authentication cannot add users external to the Workspace organization, add Google Groups, or add Chat apps to a space.
Deletes 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.
Removes a user, Google Group, or app from a space. This action is irreversible — once removed, the member cannot be recovered and will need to be re-added to the space. Use when you need to remove a specific member from a Google Chat space. Note: Deleted members will lose access to the space immediately and will need to be re-invited if they need access again.
Deletes a message from a Google Chat space. Use this action when you need to remove a message that is no longer needed, was posted in error, or is outdated. App authentication can only delete messages created by the calling Chat app. User authentication with proper permissions can delete any message in a space they manage. This action is irreversible — once deleted, the message cannot be recovered.
Deletes 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.
Deletes 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.
Deletes 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.
Downloads 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 file wrapped as a Mercury `FileDownloadable`. The download endpoint adds `?alt=media` automatically, which is required by Google to return raw bytes rather than the JSON Media resource.
Returns 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 create a new DM, use the create DM action instead.
Finds all group chat spaces that contain exactly the calling user and the specified users. This action uses the Google Chat Developer Preview API to search for GROUP_CHAT spaces whose human memberships contain exactly the calling user and the specified users. Use this action when you need to find existing group chats that include specific participants.
Gets 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.
Returns 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.
Returns 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.
Returns 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.
Returns details about a specific Google Chat space including configuration, membership count, and access settings. Use this action when you need to retrieve information about a specific space in Google Chat, such as getting the space's display name, description, membership count, threading state, or access settings. Note: Some response fields are only populated based on the OAuth scopes used. The accessSettings, predefinedPermissionSettings, and permissionSettings fields are only populated when using the chat.app.spaces scope. Requires user authentication with one of the following OAuth scopes: - https://www.googleapis.com/auth/chat.admin.spaces - https://www.googleapis.com/auth/chat.admin.spaces.readonly - https://www.googleapis.com/auth/chat.app.spaces - https://www.googleapis.com/auth/chat.bot - https://www.googleapis.com/auth/chat.spaces - https://www.googleapis.com/auth/chat.spaces.readonly
Returns 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.
Gets 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.
Returns 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.
Returns 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.
Lists 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.
Lists messages in a space that the authenticated user is a member of. Use this action when you need to retrieve messages from a Google Chat space, such as displaying message history, searching for specific messages, or monitoring space activity. Supports filtering and ordering of messages. Pagination is available via pageToken for retrieving large message sets. Requires user authentication with one of the following OAuth scopes: - https://www.googleapis.com/auth/chat.messages - https://www.googleapis.com/auth/chat.messages.readonly - https://www.googleapis.com/auth/chat.import
Lists all reactions on a specific message in a Google Chat space. Use when you need to retrieve all emoji reactions (likes, thumbs up, hearts, etc.) that users have added to a message. This action is read-only and does not modify any data. The results can be filtered by emoji type or user using the filter parameter.
Lists 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.
Lists 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
Lists 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.
Lists memberships in a space. Returns a list of all members including users, bots, and Google Groups. Use when you need to retrieve all members of a Google Chat space, such as to get a list of participants, check who has access, or find specific members by role or type. Supports pagination when there are many members in a space. Use the nextPageToken from a response to fetch subsequent pages.
Lists spaces the authenticated user is a member of in Google Chat. Use this action when you need to retrieve all spaces that the user belongs to, such as displaying available spaces or finding a specific space. Note: Group chats and direct messages (DMs) are not listed until the first message is sent. Requires user authentication with one of the following OAuth scopes: - https://www.googleapis.com/auth/chat.spaces - https://www.googleapis.com/auth/chat.spaces.readonly - https://www.googleapis.com/auth/chat.bot
Moves 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.
Changes 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.
Replaces an existing message in a Google Chat space using full replacement. Use this action when you need to completely replace a message's content, including text, cards, and other properties. Unlike patch which modifies specific fields, this action replaces the entire message. Note: Google recommends using the patch method for partial updates. This PUT method does a full replacement of the specified fields. App authentication can only replace messages created by the calling Chat app. User authentication with appropriate permissions can replace any message in spaces they manage.
Searches for spaces across a Google Workspace organization using administrator privileges. Use this action to find spaces in your Workspace org by filtering on create time, customer, display name, external user allowed, last active time, history state, or space type. Requires the caller to be a Google Workspace administrator and to pass `use_admin_access=true`. Requires one of the chat.admin.spaces / chat.admin.spaces.readonly scopes (or the equivalent user-mode chat.spaces / chat.spaces.readonly scopes).
Creates a space and adds specified users and groups to it. Use this action when you need to create a space in Google Chat and automatically add initial members in a single operation. The calling user is automatically added to the created space. Supports creating named spaces (SPACE), group chats (GROUP_CHAT), and direct messages (DIRECT_MESSAGE). For named spaces, displayName is required. For group chats and DMs, at least one membership is typically required. Note: Google groups can only be added to named spaces. If a DM already exists between users, the existing DM is returned instead of creating a new one. 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
Updates a membership in a Google Chat space, such as changing a member's role between member and manager. Use this action when you need to modify a user's role or permissions within a Google Chat space.
Updates a message in a Google Chat space, modifying its text, cards, or other properties. Use this action when you need to edit an existing message's content or properties. Supports partial updates via the updateMask parameter. App authentication can only update messages created by the calling Chat app. User authentication with appropriate permissions can update any message in spaces they manage.
Updates 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.
Updates a Google Chat space's configuration including display name, description, guidelines, history settings, access settings, and permission settings. Use this action when you need to modify the settings of an existing Google Chat space that you have admin or manager permissions for.
Updates 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.
Updates 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.
Uploads a file as an attachment to a Google Chat space using the multipart media upload endpoint. Use this when sending a file to a Chat space. The returned `attachmentUploadToken` can then be passed into `create_message` (under `attachments[].attachmentDataRef.attachmentUploadToken`) to include the file in a message. The upload uses Google's `multipart` upload protocol: a metadata part (JSON with `filename`) plus the binary file part, sent to `/upload/v1/{parent}/attachments:upload?uploadType=multipart`. Maximum file size is 200 MB. Requires user authentication. One of: `chat.import`, `chat.messages`, `chat.messages.create`.