Skip to main content

Cyware Orchestrate

Google Chat

App Vendor: Google

App Category: Messaging

Connector Version: 1.0.0

API Version: v1

About App

Google Chat is a communication and collaboration tool for organizations that integrates messaging and project management with Google Workspace. It enhances team productivity through seamless integration with Google services and third-party apps.

The Google Chat app is configured with Cyware Orchestrate to perform the following actions:

Action Name

Description

Add Member to Space 

This action adds a user or a chat app to a space.

Create a Space 

This action creates a space in Google Chat.

Create Message 

This action creates a message in a space.

Get Message Details 

This action gets details of a message in a space.

Get Metadata of Attachment 

This action gets the metadata of a message attachment.

Get Space Details 

This action gets details about a space.

Get Space Membership Details 

This action gets details about a membership in a space

Get User Read State 

This action gets details about a user's read state within a space, used to identify read and unread messages.

Get User Thread Read State 

This action gets the details about a user’s read state for a message thread in Google Chat.

List Messages 

This action lists messages in a space that the user is a member of, including messages from blocked members and spaces

List Space Memberships 

This action lists all memberships in a space

List Spaces 

This action lists all spaces from google chat.

Setup a Space 

This action creates a space and adds specified users to it.

Update Message 

This action updates a message in a space.

Update Space 

This action updates a space in Google Chat.

Update User Membership 

This action updates the membership attributes of a user.

Update User Read State 

This action updates a user's read state within a space.

Configuration Parameters

The following configuration parameters are required for the Google Chat app to communicate with the Google Chat enterprise application. The parameters can be configured by creating instances in the app.

Parameter

Description

Field Type

Required/Optional

Comments

Credentials 

Enter credentials information from the credentials file.

Note

Copy and paste the content of the file exactly as it is, without removing the quotes.

Password

Required

To know more, see Authenticate as a Google Chat app.

Scopes 

Enter the scope to grant specific permissions to the application. 

Example: $list["https://www.googleapis.com/auth/chat.spaces"]

List

Required

Default value: ["https://www.googleapis.com/auth/chat.spaces"]

To view the list of supported scopes, see Chat API scopes.

User Email 

Enter the user email to access Google Chat. 

Example: 

johndoe@gmail.com

Text

Optional

Action: Add Member to Space

This action adds a user or a chat app to a space. 

Note

You must be a Google Workspace administrator with the manage chat and spaces conversations privilege to perform this action.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space 

Enter the space name for which you want to add a member.

Example:

soc analyst

Text

Required

Data 

Enter the details of the user to be added to the space. 

Example: 

{'member': {'name':'users/john doe','type': 'human'}}

Key Value

Required

Action: Create a Space

This action creates a space in Google Chat. Spaces grouped by topics are not supported.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space Name 

Enter the name of the space. 

Example:

SOC analyst group

Text

Required

Format: spaces/{space}

Space Type 

Enter the space type to create a space. 

Text

Optional

Default type:

SPACE

Allowed types:

  • SPACE_TYPE_UNSPECIFIED

  • SPACE, GROUP_CHAT

  • DIRECT_MESSAGE

Additional Data 

Enter any additional details while creating the space. 

Example:

{externalUserAllowed: true}

Key Value

Optional

Supported values:

  • spaceThreadingState

  • spaceDetails

  • spaceHistoryState

  • importMode

  • createTime

  • lastActiveTime

  • adminInstalled

  • membershipCount

  • accessSettings

  • spaceUri

Action: Create Message

This action creates a message in a Google Chat space. The maximum message size, including text and cards, is 32,000 bytes.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space 

Enter the space name in which you want to create a message.

Text

Required

Message 

Enter a message to send.

example: {'text': 'Hi there, how are you!'}

Key Value

Required

The first link to an image, video, or web page generates a preview chip. You can also @mention a Google Chat user or everyone in the space.

Additional Data 

Enter any additional data while creating the message. 

Example: 

{"threadreply": true}

Key Value

Optional

Supported values: 

  • createTime

  • lastUpdateTime

  • deleteTime

  • formattedText

  • cardsV2[]

  • annotations[]

  • thread

  • fallbackText

  • clientAssignedMessageId

  • emojiReactionSummaries[]

  • privateMessageViewer

  • deletionMetadata

  • quotedMessageMetadata

  • attachedGifs[]

  • accessoryWidgets[]

Action: Create Message

This action creates a message in a Google Chat space. The maximum message size, including text and cards, is 32,000 bytes.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space 

Enter the space name in which you want to create a message.

Text

Required

Message 

Enter a message to send.

example: {'text': 'Hi there, how are you!'}

Key Value

Required

The first link to an image, video, or web page generates a preview chip. You can also @mention a Google Chat user or everyone in the space.

Additional Data 

Enter any additional data while creating the message. 

Example: 

{"threadreply": true}

Key Value

Optional

Supported values: 

  • createTime

  • lastUpdateTime

  • deleteTime

  • formattedText

  • cardsV2[]

  • annotations[]

  • thread

  • fallbackText

  • clientAssignedMessageId

  • emojiReactionSummaries[]

  • privateMessageViewer

  • deletionMetadata

  • quotedMessageMetadata

  • attachedGifs[]

  • accessoryWidgets[]

Action: Get Message Details

This action retrieves the details of a message in a space. This might also return a message from a blocked member or space.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space 

Enter the space name of the message.

Example:

SOC analyst

Text

Required

Message Name 

Enter the message name.

Example: 

Analyst Discussion

Text

Required

 

Action: Get Metadata of Attachment

This action retrieves the metadata of a message attachment.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space 

Enter the space name. 

Example: 

SOC analysts group

Text

Required

Message 

Enter the message name of the attachment.

Example:

Analyst Discussion

Text

Required

Attachment Name 

Enter the resource name of the attachment.

Example: 

Analyst files

Text

Required

Action: Get Space Details

This action gets details about a space.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space Name 

Enter the name of the space. 

Example:

SOC Analyst Group

Text

Required

Action: Get Space Membership Details

This action retrieves the details about a membership in a space

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space 

Enter the space name. 

Example:

Soc-analyst

Text

Required

Member 

Enter the membership name.

When authenticated as a user, you can use the user's email as an alias for member 

Example: 

john.doe@abc.com

Text

Required

Action: Get User Read State

This action returns the details about a user's read state within a space, used to identify read and unread messages.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space 

Enter the space name. 

Example

SOC Analyst group.

Text

Required

User 

Enter the user's ID, workspace email, or the alias 'me'.

Text

Optional

Default value:

me

Action: Get User Thread Read State

This action retrieves the details about a user’s read state within a message thread in Google Chat.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space 

Enter the space name of the user in a message thread. 

Example: 

SOC analysts group

Text

Required

Thread 

Enter the thread name.

Example:

Analyst p1 issue

Text

Required

User 

Enter the user's ID, workspace email, or the alias 'me'.

Text

Optional

Default value: 

me

Action: List Messages

This action lists messages in a space that the user is a member of, including messages from blocked members and spaces

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space 

Enter the space name from which you want to list the messages.

Example:

SOC analyst group

Text

Required

Additional Data 

Enter any additional parameters for listing messages. 

Example:

{'filter': 'createtime > "2023-03-16t00:00:00-00:00"'}

Key Value

Optional

Supported values:

  • pageSize

  • pageToken

  • filter

  • orderBy

  • showDeleted

Action: List Space Memberships

This action lists all memberships in a space.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space 

Enter the space name from which you want to list the memberships. 

Example:

SOC analyst group

Text

Required

Additional Data 

Enter any additional parameters to get membership details. 

Example:

{'filter': 'createtime > "2023-03-16t00:00:00-00:00"'}

Key Value

Optional

Supported values:

  • pageSize

  • pageToken

  • filter

  • showGroups

  • showInvited

  • useAdminAccess

Action: List Spaces

This action lists all spaces that you are a member of from Google Chat.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Additional Data 

Enter any additional parameters to list spaces. 

Example: 

'filter': 'createtime > "2023-03-16t00:00:00-00:00"'

Key Value

Optional

Allowed values:

  • pageSize

  • pageToken    

  • filter

Action: Setup a Space

This action creates a space and adds specified users to it. The user who is performing this action is automatically added to the space, and shouldn't be specified as a membership in the request

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space Name 

Enter the name of the space to create. 

Example:

SOC analyst group

Text

Required

Space Type 

Enter the space type.

Example:

SPACE

Text

Optional

Default type: 

SPACE

Allowed values:

  • SPACE_TYPE_UNSPECIFIED

  • SPACE_GROUP_CHAT

  • DIRECT_MESSAGE

Additional Data 

Enter any additional details while creating the space.

Example:

{externaluserallowed: true}

Key Value

Optional

Supported values:

  • singleUserBotDm

  • externalUserAllowed

  • spaceThreadingState

  • spaceHistoryState    

  • spaceDetails

  • importMode

  • adminInstalled

  • membershipCount

  • accessSettings

  • spaceUri

  • displayName

Action: Update Message

This action updates a message in a space.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space 

Enter the space name of the message. 

Example:

soc analyst group

Text

Required

Message Name 

Enter the message name to update.

Example:

Analyst issues

Text

Required

Update Mask 

Enter the fields to update in fieldmask format. Separate multiple values with commas or use * to update all field paths.

Text

Required

Allowed fields:

  • text

  • attachment

  • cards

  • cardsv2

  • accessorywidgets

Data 

Enter the message parameters you want to update. 

Example:

{'text': 'updated message!'}

Key Value

Required

Action: Update Space

This action updates a space in Google Chat.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space Name 

Enter the name of the space you want to update. 

Example:

SOC analyst group

Text

Required

Update Mask 

Enter the updated fields in fieldmask format. For entering multiple fields, use a comma as a separator.

Text

Required

Allowed fields for updating:

  • displayname

  • spacetype

  • spacedetails

  • spacehistorystate

  •  accesssettings.audience

Data 

Enter the parameters you want to update. 

Example: 

'spacedetails': 

'description': 'this group is for all the soc analysts of this company',

 'guidelines': 'you can find the guidelines in the company site.'

}

Key Value

Required

Action: Update User Membership

This action updates the membership attributes of a user.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space 

Enter the space name of the user membership. 

Example:

soc analyst

Text

Required

Member 

Enter the membership name assigned by the server.

Text

Required

Update Mask 

Enter the fields to update in fieldmask format.

Example: role

Text

Required

Allowed field:

 role

Data 

Enter the parameters you want to update. 

Example: 

{'role': 'role_manager'}

Key Value

Required

Action: Update User Read State

This action updates a user's read state within a space. This is used to identify read and unread messages.

Action Input Parameters 

Parameter

Description

Field Type

Required/Optional

Comments

Space 

Enter the space name of the read state. 

Example:

SOC analyst group.

Text

Required

Update Mask 

Enter the fields to update in fieldmask format.

Example:

lastreadtime

Text

Required

Allowed field for updating is lastreadtime

Data 

Enter the parameters you want to update. 

Example: 

{'lastreadtime': f'{datetime.datetime(2000, 1, 3).isoformat()}z'}

Key Value

Required

User 

Enter the user's ID, workspace email, or the alias 'me'.

Text

Optional

Default value:

me