Send message with the Google Chat API

Sends a text message from the user to a space or direct message. To reply in a thread, send thread with the thread name from List messages and messageReplyOption; without messageReplyOption the message starts a new thread.

Identifier
google_chat_send_message

The request

POST https://connect.reportei.com/api/tools/google_chat_send_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "spaceId": "<spaceId>",
    "text": "<text>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
spaceIdstringYesId of the space: the part after spaces/ in the name from List spaces, Get direct message or Create space.
textstringYesText of the message. Supports Chat formatting, such as *bold* and _italic_, and the first link gets a preview.
threadobjectNoThread to reply in. Goes with messageReplyOption.
messageReplyOptionstringNoNeeded to reply in a thread: REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD starts a new thread when the reply fails, and REPLY_MESSAGE_OR_FAIL returns NOT_FOUND. Only in named spaces.Values: REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD, REPLY_MESSAGE_OR_FAIL
requestIdstringNoA random UUID of your own that makes the call idempotent: repeating it with the same requestId returns the message already sent.

Supported connections

Your customer connects their Google Chat account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/google_chat, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/google_chat_send_message. It becomes your agent's tool definition with no conversion.

Other Google Chat tools

See all 11 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.