Configure a Google Chat app

This page explains how to configure and deploy a Google Chat app as a Google Workspace Add-on.

To deploy and test a Google Workspace Add-on that extends Chat, you must enable and configure a Chat app using the Google Chat API. The Chat API configuration settings are where you specify all the details about the Chat app, including the name, avatar, deployment, and interactive features that you want to use.

Prerequisites

HTTP

Apps Script

Choose a display name, avatar, and description for your Chat app

The Chat app's name, avatar, and description are displayed to users in the Chat UI. To interact with Chat apps, users see or use this information in the following ways:

  • @mention the Chat app to add it to a space or send it a message.
  • Find and start a direct message with the Chat app. In the Apps menu, direct messages display the Chat app's name and avatar.
  • From the compose bar, users can browse Chat apps and see their name, avatar, and description.

Before you configure a Chat app, you must prepare the following information:

Field Description Format
App name The display name for the Chat app. Up to 25 alphanumeric characters
Avatar URL The image that displays as your Chat app's avatar. An HTTPS URL pointing to a square graphics image (PNG or JPEG). Recommended size is 256 by 256 pixels or more.
Description A brief description of the purpose of the Chat app. Up to 40 alphanumeric characters

In the following section, you specify this information in the configurations settings in the Chat API.

Configure your Chat app in the Google Cloud console

When you have your Chat app details, open your Cloud project and configure the Chat API:

  1. In the Google Cloud console, go to the Chat API page and click the Configuration page:

    Go to the Chat API Configuration page

  2. Under Application info, fill out the App name, Avatar URL, and Description fields.

  3. Under Interactive features, click the Enable interactive features to the on position and complete the following:

    1. Under Functionality, select one or more checkboxes to make your Chat app available to install and use:

      • Receive 1:1 messages: Users can install and message with the Chat app in a dedicated space between the user and Chat app.

      • Join spaces and group conversations: Users can add and interact with the Chat app in spaces with multiple people.

    2. Under Connection settings, select the architecture that you want to use to receive event objects from Chat:

      • To use an HTTP service, select HTTP endpoint URL and provide a URL.
      • To use a Google Apps Script project, select Apps Script and provide a deployment ID for the project.

    3. Optional: To receive event objects to more than one endpoint or function, go to Advanced settings > Triggers and provide or update the callback functions for the following Chat triggers:

      • ADDED_TO_SPACE: A user adds the Chat app to a group conversation or space, or installs the Chat app for 1:1 messages.
      • MESSAGE: A user sends a message to the Chat app. For example, sends a direct message to the Chat app or @mentions the Chat app in a space with multiple people.
      • REMOVED_FROM_SPACE: A user uninstalls or removes the Chat app from a space.

    4. Optional: Add other interactive features such as slash commands or link previews.

    5. Under Visibility, specify your email so that you can install and test the Chat app before you publish to the Google Workspace Marketplace. You can specify up to five individuals, or one or more Google Groups from your Google Workspace organization.

  4. Optional: Under Logs, select the Log errors to Logging checkbox to use Google Cloud Logging. For more information, see Query error logs for Chat apps in the Chat API documentation.

  5. Click Save.

After you save the configuration, anyone that you specified in the Chat API's Visibility setting can install, test, or use the Chat app. To start testing and debugging your Chat app, see Test interactive features for Google Chat apps in the Chat API documentation.

Considerations for existing Google Workspace Add-ons

Chat apps require a different configuration compared to Google Workspace Add-ons that extend other Google Workspace applications. If your add-on extends other Google Workspace applications, consider the following requirements for configuring the Chat app:

  • Both individuals and Google Workspace administrators must be able to install your add-on from the Marketplace. You configure these installation settings in the Google Workspace Marketplace SDK.
  • Chat apps don't use the name and logo that you configure for other Google Workspace applications in the addons.common object of the manifest.
  • For add-ons that are published to the Google Workspace Marketplace, you can't save a draft of any changes to the Google Chat API configuration settings. After you update and save the Chat API configuration settings, the updated Chat app is available to all existing users. To update your Marketplace listing, you can create a draft before submitting any changes.

  • If you built your add-on using Apps Script:

  • If you built your add-on using an HTTP service, omit any Chat app configuration details in the manifest and deployments that you create using the Google Workspace Add-ons API. The HTTP deployments that you specify in the Google Workspace Marketplace SDK are only used for other Google Workspace applications.