Google Chat

App · 8 actions

Send messages, react, and set up spaces in Google Chat with your Google Workspace account.

Actions

ActionWhat it does
Add person to spaceAdd someone to a space by their email.
Add reactionReact to a message with an emoji.
Delete messageDelete a message the connected account sent, and any replies in its thread.
Edit messageChange the text of a message the connected account sent.
Find direct messageFind the direct message conversation with one person, by their email, to send them a message.
List messagesList a space's messages, newest first.
Send messageSend a message to a space, or a reply in a thread.
Set up spaceCreate a named space and add people to it by email.

Add person to space

Add someone to a space by their email.

Inputs

SpaceparenttextRequired
The space to add them to.
PersonmembertextRequired
Their email.
Roleroletext
Whether they can manage the space, or are a member.One of: ROLE_MEMBER (Member), ROLE_MANAGER (Manager).

Outputs

dataobject
Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space.
Example output
{
  "data": {
    "affiliation": "AFFILIATION_UNSPECIFIED",
    "createTime": "example",
    "deleteTime": "example",
    "groupMember": {
      "name": "example"
    },
    "member": {
      "avatarUrl": "example",
      "displayName": "example",
      "domainId": "example",
      "email": "example",
      "isAnonymous": false,
      "name": "example",
      "type": "TYPE_UNSPECIFIED"
    },
    "name": "example",
    "role": "MEMBERSHIP_ROLE_UNSPECIFIED",
    "state": "MEMBERSHIP_STATE_UNSPECIFIED"
  }
}

Add reaction

React to a message with an emoji.

Inputs

MessageparenttextRequired
The message to react to, as an earlier step gave it (its name).
EmojiemojitextRequired
The emoji itself, such as 👍.

Outputs

dataobject
A reaction to a message.
Example output
{
  "data": {
    "emoji": {
      "customEmoji": {
        "emojiName": "example",
        "name": "example",
        "payload": {},
        "temporaryImageUri": "example",
        "uid": "example"
      },
      "unicode": "example"
    },
    "name": "example",
    "user": {
      "avatarUrl": "example",
      "displayName": "example",
      "domainId": "example",
      "email": "example",
      "isAnonymous": false,
      "name": "example",
      "type": "TYPE_UNSPECIFIED"
    }
  }
}

Delete message

Delete a message the connected account sent, and any replies in its thread.

Inputs

MessagenametextRequired
The message to delete, as an earlier step gave it (its name).

Outputs

dataobject
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
Example output
{
  "data": {}
}

Edit message

Change the text of a message the connected account sent.

Inputs

MessagenametextRequired
The message to change, as an earlier step gave it (its name).
Message texttexttext
The new text.

Outputs

dataobject
A message in a Google Chat space.
Example output
{
  "data": {
    "accessoryWidgets": [],
    "actionResponse": {
      "dialogAction": {
        "actionStatus": {},
        "dialog": {}
      },
      "type": "TYPE_UNSPECIFIED",
      "updatedWidget": {
        "suggestions": {},
        "widget": "example"
      },
      "url": "example"
    },
    "annotations": [],
    "argumentText": "example",
    "attachedGifs": [],
    "attachment": [],
    "cards": [],
    "cardsV2": [],
    "clientAssignedMessageId": "example",
    "createTime": "example",
    "deleteTime": "example",
    "deletionMetadata": {
      "deletionType": "DELETION_TYPE_UNSPECIFIED"
    },
    "elements": {
      "citations": [],
      "citedSources": []
    },
    "emojiReactionSummaries": [],
    "fallbackText": "example",
    "formattedText": "example",
    "lastUpdateTime": "example",
    "markupSyntax": "MARKUP_SYNTAX_UNSPECIFIED",
    "matchedUrl": {
      "url": "example"
    },
    "name": "example",
    "privateMessageViewer": {
      "avatarUrl": "example",
      "displayName": "example",
      "domainId": "example",
      "email": "example",
      "isAnonymous": false,
      "name": "example",
      "type": "TYPE_UNSPECIFIED"
    },
    "quotedMessageMetadata": {
      "forwardedMetadata": {
        "space": "example",
        "spaceDisplayName": "example"
      },
      "lastUpdateTime": "example",
      "name": "example",
      "quoteType": "QUOTE_TYPE_UNSPECIFIED",
      "quotedMessageSnapshot": {
        "annotations": [],
        "attachments": [],
        "formattedText": "example",
        "sender": "example",
        "text": "example"
      }
    },
    "sender": {
      "avatarUrl": "example",
      "displayName": "example",
      "domainId": "example",
      "email": "example",
      "isAnonymous": false,
      "name": "example",
      "type": "TYPE_UNSPECIFIED"
    },
    "silent": false,
    "slashCommand": {
      "commandId": "example"
    },
    "space": {
      "accessSettings": {
        "accessPermissionSettings": {},
        "accessState": "ACCESS_STATE_UNSPECIFIED",
        "audience": "example"
      },
      "adminInstalled": false,
      "createTime": "example",
      "customer": "example",
      "displayName": "example",
      "externalUserAllowed": false,
      "importMode": false,
      "importModeExpireTime": "example",
      "lastActiveTime": "example",
      "membershipCount": {
        "joinedDirectHumanUserCount": 1,
        "joinedGroupCount": 1
      },
      "name": "example",
      "permissionSettings": {
        "manageApps": {},
        "manageMembersAndGroups": {},
        "manageWebhooks": {},
        "modifySpaceDetails": {},
        "postMessages": {},
        "replyMessages": {},
        "toggleHistory": {},
        "useAtMentionAll": {},
        "viewSpaceMembership": {}
      },
      "predefinedPermissionSettings": "PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED",
      "singleUserBotDm": false,
      "spaceDetails": {
        "description": "example",
        "guidelines": "example"
      },
      "spaceHistoryState": "HISTORY_STATE_UNSPECIFIED",
      "spaceThreadingState": "SPACE_THREADING_STATE_UNSPECIFIED",
      "spaceType": "SPACE_TYPE_UNSPECIFIED",
      "spaceUri": "example",
      "threaded": false,
      "type": "TYPE_UNSPECIFIED"
    },
    "text": "example",
    "thread": {
      "name": "example",
      "threadKey": "example"
    },
    "threadReply": false
  }
}

Find direct message

Find the direct message conversation with one person, by their email, to send them a message.

Inputs

PersonnametextRequired
Their email.

Outputs

dataobject
A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.
Example output
{
  "data": {
    "accessSettings": {
      "accessPermissionSettings": {
        "discoverSpaceSetting": {},
        "joinSpaceSetting": {},
        "viewSpaceMembershipSetting": {}
      },
      "accessState": "ACCESS_STATE_UNSPECIFIED",
      "audience": "example"
    },
    "adminInstalled": false,
    "createTime": "example",
    "customer": "example",
    "displayName": "example",
    "externalUserAllowed": false,
    "importMode": false,
    "importModeExpireTime": "example",
    "lastActiveTime": "example",
    "membershipCount": {
      "joinedDirectHumanUserCount": 1,
      "joinedGroupCount": 1
    },
    "name": "example",
    "permissionSettings": {
      "manageApps": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      },
      "manageMembersAndGroups": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      },
      "manageWebhooks": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      },
      "modifySpaceDetails": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      },
      "postMessages": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      },
      "replyMessages": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      },
      "toggleHistory": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      },
      "useAtMentionAll": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      },
      "viewSpaceMembership": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      }
    },
    "predefinedPermissionSettings": "PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED",
    "singleUserBotDm": false,
    "spaceDetails": {
      "description": "example",
      "guidelines": "example"
    },
    "spaceHistoryState": "HISTORY_STATE_UNSPECIFIED",
    "spaceThreadingState": "SPACE_THREADING_STATE_UNSPECIFIED",
    "spaceType": "SPACE_TYPE_UNSPECIFIED",
    "spaceUri": "example",
    "threaded": false,
    "type": "TYPE_UNSPECIFIED"
  }
}

List messages

List a space's messages, newest first.

Inputs

SpaceparenttextRequired
The space to read.
How manypage_sizenumber
The most messages to get, newest first.

Outputs

dataobject
Response message for listing messages.
Example output
{
  "data": {
    "messages": [],
    "nextPageToken": "example"
  }
}

Send message

Send a message to a space, or a reply in a thread.

Inputs

SpaceparenttextRequired
The space or direct message to send it to.
Reply in threadthreadtext
To reply in a thread, the thread of an earlier message (its thread name). Leave it empty to start a new thread.
MessagetexttextRequired
What to say.

Outputs

dataobject
A message in a Google Chat space.
Example output
{
  "data": {
    "accessoryWidgets": [],
    "actionResponse": {
      "dialogAction": {
        "actionStatus": {},
        "dialog": {}
      },
      "type": "TYPE_UNSPECIFIED",
      "updatedWidget": {
        "suggestions": {},
        "widget": "example"
      },
      "url": "example"
    },
    "annotations": [],
    "argumentText": "example",
    "attachedGifs": [],
    "attachment": [],
    "cards": [],
    "cardsV2": [],
    "clientAssignedMessageId": "example",
    "createTime": "example",
    "deleteTime": "example",
    "deletionMetadata": {
      "deletionType": "DELETION_TYPE_UNSPECIFIED"
    },
    "elements": {
      "citations": [],
      "citedSources": []
    },
    "emojiReactionSummaries": [],
    "fallbackText": "example",
    "formattedText": "example",
    "lastUpdateTime": "example",
    "markupSyntax": "MARKUP_SYNTAX_UNSPECIFIED",
    "matchedUrl": {
      "url": "example"
    },
    "name": "example",
    "privateMessageViewer": {
      "avatarUrl": "example",
      "displayName": "example",
      "domainId": "example",
      "email": "example",
      "isAnonymous": false,
      "name": "example",
      "type": "TYPE_UNSPECIFIED"
    },
    "quotedMessageMetadata": {
      "forwardedMetadata": {
        "space": "example",
        "spaceDisplayName": "example"
      },
      "lastUpdateTime": "example",
      "name": "example",
      "quoteType": "QUOTE_TYPE_UNSPECIFIED",
      "quotedMessageSnapshot": {
        "annotations": [],
        "attachments": [],
        "formattedText": "example",
        "sender": "example",
        "text": "example"
      }
    },
    "sender": {
      "avatarUrl": "example",
      "displayName": "example",
      "domainId": "example",
      "email": "example",
      "isAnonymous": false,
      "name": "example",
      "type": "TYPE_UNSPECIFIED"
    },
    "silent": false,
    "slashCommand": {
      "commandId": "example"
    },
    "space": {
      "accessSettings": {
        "accessPermissionSettings": {},
        "accessState": "ACCESS_STATE_UNSPECIFIED",
        "audience": "example"
      },
      "adminInstalled": false,
      "createTime": "example",
      "customer": "example",
      "displayName": "example",
      "externalUserAllowed": false,
      "importMode": false,
      "importModeExpireTime": "example",
      "lastActiveTime": "example",
      "membershipCount": {
        "joinedDirectHumanUserCount": 1,
        "joinedGroupCount": 1
      },
      "name": "example",
      "permissionSettings": {
        "manageApps": {},
        "manageMembersAndGroups": {},
        "manageWebhooks": {},
        "modifySpaceDetails": {},
        "postMessages": {},
        "replyMessages": {},
        "toggleHistory": {},
        "useAtMentionAll": {},
        "viewSpaceMembership": {}
      },
      "predefinedPermissionSettings": "PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED",
      "singleUserBotDm": false,
      "spaceDetails": {
        "description": "example",
        "guidelines": "example"
      },
      "spaceHistoryState": "HISTORY_STATE_UNSPECIFIED",
      "spaceThreadingState": "SPACE_THREADING_STATE_UNSPECIFIED",
      "spaceType": "SPACE_TYPE_UNSPECIFIED",
      "spaceUri": "example",
      "threaded": false,
      "type": "TYPE_UNSPECIFIED"
    },
    "text": "example",
    "thread": {
      "name": "example",
      "threadKey": "example"
    },
    "threadReply": false
  }
}

Set up space

Create a named space and add people to it by email.

Inputs

Space namespacetextRequired
What to call the space.
Peoplemembershipstext
The people to add, by email, separated by commas.

Outputs

dataobject
A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.
Example output
{
  "data": {
    "accessSettings": {
      "accessPermissionSettings": {
        "discoverSpaceSetting": {},
        "joinSpaceSetting": {},
        "viewSpaceMembershipSetting": {}
      },
      "accessState": "ACCESS_STATE_UNSPECIFIED",
      "audience": "example"
    },
    "adminInstalled": false,
    "createTime": "example",
    "customer": "example",
    "displayName": "example",
    "externalUserAllowed": false,
    "importMode": false,
    "importModeExpireTime": "example",
    "lastActiveTime": "example",
    "membershipCount": {
      "joinedDirectHumanUserCount": 1,
      "joinedGroupCount": 1
    },
    "name": "example",
    "permissionSettings": {
      "manageApps": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      },
      "manageMembersAndGroups": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      },
      "manageWebhooks": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      },
      "modifySpaceDetails": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      },
      "postMessages": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      },
      "replyMessages": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      },
      "toggleHistory": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      },
      "useAtMentionAll": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      },
      "viewSpaceMembership": {
        "assistantManagersAllowed": false,
        "managersAllowed": false,
        "membersAllowed": false
      }
    },
    "predefinedPermissionSettings": "PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED",
    "singleUserBotDm": false,
    "spaceDetails": {
      "description": "example",
      "guidelines": "example"
    },
    "spaceHistoryState": "HISTORY_STATE_UNSPECIFIED",
    "spaceThreadingState": "SPACE_THREADING_STATE_UNSPECIFIED",
    "spaceType": "SPACE_TYPE_UNSPECIFIED",
    "spaceUri": "example",
    "threaded": false,
    "type": "TYPE_UNSPECIFIED"
  }
}

On this page