- [Resource: ChatAppConfig](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#ChatAppConfig)
- [JSON representation](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#ChatAppConfig.SCHEMA_REPRESENTATION)
- [AppState](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AppState)
- [InteractiveFeatureConfig](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#InteractiveFeatureConfig)
- [JSON representation](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#InteractiveFeatureConfig.SCHEMA_REPRESENTATION)
- [ConnectionConfig](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#ConnectionConfig)
- [JSON representation](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#ConnectionConfig.SCHEMA_REPRESENTATION)
- [HttpEndpointConfig](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#HttpEndpointConfig)
- [JSON representation](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#HttpEndpointConfig.SCHEMA_REPRESENTATION)
- [HttpPerEventEndpointConfig](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#HttpPerEventEndpointConfig)
- [JSON representation](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#HttpPerEventEndpointConfig.SCHEMA_REPRESENTATION)
- [AppsScriptEndpointConfig](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AppsScriptEndpointConfig)
- [JSON representation](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AppsScriptEndpointConfig.SCHEMA_REPRESENTATION)
- [AppsScriptPerEventEndpointConfig](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AppsScriptPerEventEndpointConfig)
- [JSON representation](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AppsScriptPerEventEndpointConfig.SCHEMA_REPRESENTATION)
- [CloudPubSubEndpointConfig](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#CloudPubSubEndpointConfig)
- [JSON representation](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#CloudPubSubEndpointConfig.SCHEMA_REPRESENTATION)
- [DialogflowEndpointConfig](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#DialogflowEndpointConfig)
- [JSON representation](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#DialogflowEndpointConfig.SCHEMA_REPRESENTATION)
- [DialogflowEdition](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#DialogflowEdition)
- [AppCommand](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AppCommand)
- [JSON representation](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AppCommand.SCHEMA_REPRESENTATION)
- [CommandType](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#CommandType)
- [UrlPattern](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#UrlPattern)
- [JSON representation](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#UrlPattern.SCHEMA_REPRESENTATION)
- [AgenticConfig](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AgenticConfig)
- [JSON representation](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AgenticConfig.SCHEMA_REPRESENTATION)
- [MarkupSyntax](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#MarkupSyntax)
- [Methods](https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#METHODS_SUMMARY)
## Resource: ChatAppConfig
Represents the configuration of a Google Chat app built as a Google Workspace add-on.
> [!WARNING]
> **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
| JSON representation |
|---|
| ``` { "name": string, "displayName": string, "description": string, "interactiveFeatureConfig": { object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#InteractiveFeatureConfig`) }, "avatarUri": string, "state": enum (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AppState`), "errorLoggingEnabled": boolean, "markupSyntax": enum (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#MarkupSyntax`) } ``` |
| Fields ||
|---|---|
| `name` | `string` Required. Identifier. Resource name of the Chat app configuration. Format: `projects/{project}/chatAppConfig`, where `{project}` is the Google Cloud project number. |
| `displayName` | `string` Required. The display name of the Chat app. Length should be between 3 and 25 characters. |
| `description` | `string` Required. A short description of the Chat app. Should be between 1 and 40 characters. |
| `interactiveFeatureConfig` | ``object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#InteractiveFeatureConfig`)`` Optional. The settings for interactive features of the app. If this is not provided, the app will be non-interactive, meaning that it can use the Chat API, but users can't interact with the app. |
| `avatarUri` | `string` Optional. The URL for the app's avatar image. Must be an HTTPS URL that hosts a square (aspect ratio of 1:1) PNG image. Recommended minimum size: 256 by 256 pixels. A default app avatar will be used if not specified. |
| `state` | ``enum (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AppState`)`` Optional. The state of the app. Defaults to `ACTIVE` if not specified. |
| `errorLoggingEnabled` | `boolean` Optional. Whether to log errors to Cloud Logging. Defaults to `false` if not specified. |
| `markupSyntax` | ``enum (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#MarkupSyntax`)`` Optional. The default markup syntax for messages sent or read by this Chat app. Defaults to `MARKUP_SYNTAX_MARKDOWN` if not specified. |
## AppState
The current state of the Chat app.
> [!WARNING]
> **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
| Enums ||
|---|---|
| `APP_STATE_UNSPECIFIED` | Default value. Unspecified. |
| `ACTIVE` | Maps to LIVE in the Chat API configuration page. The app is active, it can be found and used by people with visibility. |
| `DISABLED` | The app is disabled, it can no longer be found by anyone, and nobody can talk to the app any more. |
## InteractiveFeatureConfig
Settings for the [interactive features](https://developers.google.com/workspace/chat/interact-users-overview) of the app.
> [!WARNING]
> **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
| JSON representation |
|---|
| ``` { "connectionConfig": { object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#ConnectionConfig`) }, "appCommands": [ { object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AppCommand`) } ], "urlPatterns": [ { object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#UrlPattern`) } ], "allowlistedTestingPrincipals": [ string ], "agenticConfig": { object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AgenticConfig`) }, "supportsMultiuserSpaces": boolean } ``` |
| Fields ||
|---|---|
| `connectionConfig` | ``object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#ConnectionConfig`)`` Required. How the app receives events from Google Chat. |
| `appCommands[]` | ``object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AppCommand`)`` Optional. Configuration for app commands. |
| `urlPatterns[]` | ``object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#UrlPattern`)`` Optional. Configuration for link previews. |
| `allowlistedTestingPrincipals[]` | `string` Optional. The email addresses of users and groups in your Google Workspace domain who can find and use the app. |
| `agenticConfig` | ``object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AgenticConfig`)`` Optional. Configuration for agentic features of the Chat app.
> [!WARNING] > **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
|
| `supportsMultiuserSpaces` | `boolean` Optional. Whether the app can be added to 1:1 human DMs, group chats and spaces. Defaults to `false` if not specified. |
## ConnectionConfig
How the app receives events.
> [!WARNING]
> **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
| JSON representation |
|---|
| ``` { "httpEndpointConfig": { object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#HttpEndpointConfig`) }, "appsScriptEndpointConfig": { object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AppsScriptEndpointConfig`) }, "cloudPubSubEndpointConfig": { object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#CloudPubSubEndpointConfig`) }, "dialogflowEndpointConfig": { object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#DialogflowEndpointConfig`) } } ``` |
| Fields ||
|---|---|
| The type of connection. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `httpEndpointConfig` | ``object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#HttpEndpointConfig`)`` HTTP endpoint configuration. |
| `appsScriptEndpointConfig` | ``object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AppsScriptEndpointConfig`)`` Apps Script deployment configuration. |
| `cloudPubSubEndpointConfig` | ``object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#CloudPubSubEndpointConfig`)`` Pub/Sub topic configuration. |
| `dialogflowEndpointConfig` | ``object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#DialogflowEndpointConfig`)`` Dialogflow configuration. |
| End of mutually exclusive fields. ||
## HttpEndpointConfig
HTTP endpoint configuration.
> [!WARNING]
> **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
| JSON representation |
|---|
| ``` { "commonUrl": string, "perEventEndpointConfig": { object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#HttpPerEventEndpointConfig`) } } ``` |
| Fields ||
|---|---|
| The HTTP endpoint URL configuration. The following is a list of mutually exclusive fields. At most one of the fields will be set in a response: ||
| `commonUrl` | `string` Optional. The HTTPS URL to which Google Chat sends all interactive events. |
| `perEventEndpointConfig` | ``object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#HttpPerEventEndpointConfig`)`` Optional. Separate HTTPS URLs to which Google Chat sends each type of interactive event. |
| End of mutually exclusive fields. ||
## HttpPerEventEndpointConfig
HTTP endpoint configuration for specific event types.
> [!WARNING]
> **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
| JSON representation |
|---|
| ``` { "appCommandEndpoint": string, "addedToSpaceEndpoint": string, "messageEndpoint": string, "removedFromSpaceEndpoint": string } ``` |
| Fields ||
|---|---|
| `appCommandEndpoint` | `string` Required. HTTPS URL endpoint for app command events. |
| `addedToSpaceEndpoint` | `string` Required. HTTPS URL endpoint for added to space events. |
| `messageEndpoint` | `string` Required. HTTPS URL endpoint for message events. |
| `removedFromSpaceEndpoint` | `string` Required. HTTPS URL endpoint for removed from space events. |
## AppsScriptEndpointConfig
Apps Script endpoint configuration.
> [!WARNING]
> **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
| JSON representation |
|---|
| ``` { "deploymentId": string, "perEventEndpointConfig": { object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AppsScriptPerEventEndpointConfig`) } } ``` |
| Fields ||
|---|---|
| `deploymentId` | `string` Required. The Apps Script deployment ID. |
| `perEventEndpointConfig` | ``object (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#AppsScriptPerEventEndpointConfig`)`` Optional. The names of the Apps Script functions that Google Chat calls for each type of interactive event. If not specified, Chat calls the default function for each event type. |
## AppsScriptPerEventEndpointConfig
Apps Script endpoint configuration for specific event types.
> [!WARNING]
> **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
| JSON representation |
|---|
| ``` { "appCommandEndpoint": string, "addedToSpaceEndpoint": string, "messageEndpoint": string, "removedFromSpaceEndpoint": string } ``` |
| Fields ||
|---|---|
| `appCommandEndpoint` | `string` Optional. Function name for app command events. If not specified, the default `onAppCommand` function name will be used. |
| `addedToSpaceEndpoint` | `string` Optional. Function name for added to space events. If not specified, the default `onAddedToSpace` function name will be used. |
| `messageEndpoint` | `string` Optional. Function name for message events. If not specified, the default `onMessage` function name will be used. |
| `removedFromSpaceEndpoint` | `string` Optional. Function name for removed from space events. If not specified, the default `onRemovedFromSpace` function name will be used. |
## CloudPubSubEndpointConfig
Pub/Sub endpoint configuration.
> [!WARNING]
> **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
| JSON representation |
|---|
| ``` { "topic": string } ``` |
| Fields ||
|---|---|
| `topic` | `string` Required. The Pub/Sub topic to which Google Chat publishes all interactive events. The topic must be in the same Google Cloud project as the app, and Chat must have permission to publish messages to the topic. For details, see [Build a Google Chat app with Pub/Sub](https://developers.google.com/workspace/chat/quickstart/pub-sub#configure-chat-app). Format: `projects/{project}/topics/{topic}` |
## DialogflowEndpointConfig
Dialogflow endpoint configuration.
> [!WARNING]
> **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
| JSON representation |
|---|
| ``` { "dialogflowEdition": enum (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#DialogflowEdition`), "agent": string } ``` |
| Fields ||
|---|---|
| `dialogflowEdition` | ``enum (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#DialogflowEdition`)`` Required. The Dialogflow edition. |
| `agent` | `string` Optional. The Dialogflow CX agent or environment name. Required for Dialogflow CX. Do not set for Dialogflow ES. Format: `projects/{project}/locations/{location}/agents/{agent}` or `projects/{project}/locations/{location}/agents/{agent}/environments/{environment}`. |
## DialogflowEdition
Dialogflow edition type.
> [!WARNING]
> **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
| Enums ||
|---|---|
| `DIALOGFLOW_EDITION_UNSPECIFIED` | Default value. Unspecified. |
| `ES` | Dialogflow ES edition. To use this edition, a Dialogflow ES agent must exist in the same Google Cloud project as the app. Google Chat sends all interactive events to that agent. |
| `CX` | Dialogflow CX edition. To use this edition, a Dialogflow CX agent must exist in the same Google Cloud project as the app and be specified in the `agent` field. Google Chat sends all interactive events to that agent. |
## AppCommand
Configuration for an [app command](https://developers.google.com/workspace/chat/commands).
> [!WARNING]
> **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
| JSON representation |
|---|
| ``` { "commandType": enum (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#CommandType`), "commandId": integer, "command": string, "displayName": string, "description": string, "dialogEnabled": boolean, "loadingNotificationMessage": string } ``` |
| Fields ||
|---|---|
| `commandType` | ``enum (`https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig#CommandType`)`` Required. The type of this command. |
| `commandId` | `integer` Required. The ID of the command (1-1000). Must be unique within the app. |
| `command` | `string` Optional. The name of the command. Required for SLASH_COMMAND, do not set for other command types. Must start with a "/", e.g., "/command". |
| `displayName` | `string` Optional. The user-friendly display name of the command. Required for MESSAGE_ACTION and QUICK_COMMAND, do not set for SLASH_COMMAND. |
| `description` | `string` Required. A short description of the command. |
| `dialogEnabled` | `boolean` Optional. Whether this command should trigger a dialog. Defaults to `false`, if not specified. |
| `loadingNotificationMessage` | `string` Optional. A notification to be sent to the user when they trigger the message action. Only supported for MESSAGE_ACTION commands. |
## CommandType
The type of the App Command.
> [!WARNING]
> **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
| Enums ||
|---|---|
| `COMMAND_TYPE_UNSPECIFIED` | Default value. Unspecified. |
| `SLASH_COMMAND` | A command invoked by typing a '/' followed by the command name. It may accept additional arguments in the message text. |
| `QUICK_COMMAND` | A quick command invoked from the message compose context menu. Quick commands do not accept additional arguments. |
| `MESSAGE_ACTION` | A command invoked from a message context menu. |
## UrlPattern
Configuration for a [link preview](https://developers.google.com/workspace/chat/preview-links).
> [!WARNING]
> **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
| JSON representation |
|---|
| ``` { "hostPattern": string, "pathPrefix": string } ``` |
| Fields ||
|---|---|
| `hostPattern` | `string` Required. The domain to match. Match a specific subdomain, like "subdomain.example.com", or an entire domain by including an asterisk (\*) as a leading wildcard character. For example, "\*.example.com" matches "https://subdomain.example.com" and "https://any.number.of.subdomains.example.com". |
| `pathPrefix` | `string` Optional. Path prefix appended to the host pattern. If blank, matches all URLs in the host pattern. For example, when paired with the host pattern "subdomain.example.com", specify "path/" to match page URLs that begin with "https://subdomain.example.com/path/". |
## AgenticConfig
Configuration for agentic features of the Chat app.
> [!WARNING]
> **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
| JSON representation |
|---|
| ``` { "isAgentic": boolean } ``` |
| Fields ||
|---|---|
| `isAgentic` | `boolean` Optional. Whether the app is declared as an agentic app. Defaults to `false` if not specified.
> [!WARNING] > **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
|
## MarkupSyntax
The markup syntax used to format message text for this Chat app.
> [!WARNING]
> **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features.
| Enums ||
|---|---|
| `MARKUP_SYNTAX_UNSPECIFIED` | Default value. Unspecified. Existing Chat apps created before `markup_syntax` was introduced have this value and use `MARKUP_SYNTAX_CHAT` until explicitly updated. |
| `MARKUP_SYNTAX_CHAT` | Uses Google Chat's markup syntax. See for more information. |
| `MARKUP_SYNTAX_MARKDOWN` | Uses Markdown syntax. This syntax is based on the [CommonMark](https://commonmark.org/help/) specification, with additional extensions. See for more information. |
| ## Methods ||
|---|---|
| ### `https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig/get` | > [!WARNING] > **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. Gets the Chat app configuration of a project. |
| ### `https://developers.google.com/workspace/add-ons/reference/rest/v1/projects.chatAppConfig/patch` | > [!WARNING] > **Developer Preview:** Available as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), which grants early access to certain features. Updates the Chat app configuration of a project. |