EventType

  • Google Chat app interaction events are triggered by various user actions, such as sending messages, adding/removing the app, interacting with cards, and updating widgets.

  • These events provide context about the interaction, like the user, space, and specific action taken, allowing your app to respond appropriately.

  • ADDED_TO_SPACE andREMOVED_FROM_SPACE events help manage the app's presence in spaces, whileCARD_CLICKED enables handling user interactions with card elements.

  • MESSAGE events cover various scenarios, including direct messages, @mentions, slash commands, and link previews, enabling diverse app functionalities.

  • APP_HOME andSUBMIT_FORM events allow for interactions specific to apps that utilize the app home feature for a more integrated experience within Google Chat.

Types ofGoogle Chat app interaction events.

To configure your Chat app to receive interaction events, seeReceive and respond to user interactions.

Note: This EventType is only used forChat interaction events. If your Chat app is built as aGoogle Workspace add-on, seeChat event objects in the add-ons documentation.

Enums
UNSPECIFIEDDefault value for the enum. DO NOT USE.
MESSAGE

A user sends the Chat app a message, or invokes the Chat app in a space. Examples of message events include:

  • Any message in a direct message (DM) space with the Chat app.
  • A message in a multi-person space where a person @mentions the Chat app, or uses one of itsslash commands.
  • If you've configured link previews for your Chat app, a user posts a message that contains a link that matches the configured URL pattern.
ADDED_TO_SPACE

A user adds the Chat app to a space, or a Google Workspace administrator installs the Chat app in direct message spaces for users in their organization. Chat apps typically respond to this interaction event by posting a welcome message in the space.

When administrators install Chat apps, thespace.adminInstalled field is set totrue and users can't uninstall them. To learn about Chat apps installed by administrators, see Google Workspace Admin Help's documentation,Install Marketplace apps in your domain.

REMOVED_FROM_SPACE

A user removes the Chat app from a space, or a Google Workspace administrator uninstalls the Chat app for a user in their organization. Chat apps can't respond with messages to this event, because they have already been removed.

When administrators uninstall Chat apps, thespace.adminInstalled field is set tofalse. If a user installed the Chat app before the administrator, the Chat app remains installed for the user and the Chat app doesn't receive aREMOVED_FROM_SPACE interaction event.

CARD_CLICKED

A user clicks an interactive element of a card or dialog from a Chat app, such as a button. To receive an interaction event, the button must trigger another interaction with the Chat app. For example, a Chat app doesn't receive aCARD_CLICKED interaction event if a user clicks a button that opens a link to a website, but receives interaction events in the following examples:

  • The user clicks aSend feedback button on a card, which opens a dialog for the user to input information.
  • The user clicks aSubmit button after inputting information into a card or dialog.

If a user clicks a button to open, submit, or cancel a dialog, theCARD_CLICKED interaction event'sisDialogEvent field is set totrue and includes aDialogEventType.

WIDGET_UPDATEDA user updates a widget in a card message or dialog. This event is triggered when a user interacts with a widget that has an associated action.
APP_COMMANDA user uses a Chat appcommand, including slash commands and quick commands.
APP_HOME

A user opens a direct message from a Chat app that uses app home. Only thetype,user, andspace fields are included for events of this type. For more information, seeBuild a homepage for a Google Chat app.

SUBMIT_FORM

A user submits information in an app home card. Only thetype,user, andspace fields are included for events of this type. For more information, seeBuild a homepage for a Google Chat app.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-09-11 UTC.