Google Chat Incident Response app

This code sample creates a Google Chat app that helps users respond to technical incidents.

This example creates an Apps Script app with two parts: a web page and a Chat app.

The web page simulates an incident by asking users to enter some basic incident information: title, description, and email addresses of the responders. The information entered is passed on to the Chat app, which automatically creates a Chat space, adds the responders as members, and posts the incident description as a message. This represents a starting point for an incident response in this example, but it could be modified, for example, to respond automatically to an outage detected by a monitoring agent or a high-priority case created in a CRM.

After the response team resolves the incident, they use a slash command to automatically create a post-mortem in Google Docs. The app adds a user-provided description of the incident resolution, a transcript of the Chat conversation, and a summary of the conversation (automatically generated using Vertex AI) to the post-mortem.

Tutorial

For detailed implementation instructions, follow the Incident Response Tutorial in the Google Chat developer documentation.

Run the sample

To run this sample, you need a Google Cloud project in a Google Workspace account with billing enabled, required APIs turned on, and authentication set up. You also need an Apps Script project connected with the Google Cloud project. Once published, open the app's web page to start an incident response.

To publish the Chat app:

1. Create a Google Cloud project

In the Google Cloud console, go to Menu > IAM & Admin > Create a Project.
In the Project Name field, enter a descriptive name for your project. Optional: To edit the Project ID, click Edit. The project ID can't be changed after the project is created, so choose an ID that meets your needs for the lifetime of the project.
In the Location field, click Browse to display potential locations for your project. Then, click Select.
Click Create. The console navigates to the Dashboard page and your project is created within a few minutes.

For further information on Google Cloud projects, refer to Creating and managing projects.

2. Enable billing for the Google Cloud project

In the Google Cloud console, go to Billing. Click Menu > Billing > My Projects.
In Select an organization, choose the organization hosting your Google Cloud project.
In the project row, open the Actions menu, click Change billing, and choose the desired destination Cloud Billing account. Note: If you are not able to select Change billing, you do not have the permissions needed to make this change. See Permissions required to enable billing for more information.
Click Set account.
(Optional) After you link a project to a billing account, you can lock the link to prevent the project from unintentionally being moved (linked) to a different billing account or the project link being deleted from the billing account.

3. Enable the APIs

To complete this tutorial, you must enable the following APIs:
1. Google Chat API
2. Google Docs API
3. Admin SDK API
4. Vertex AI API
Confirm that you're enabling the APIs in the correct project, then click Next.
Confirm that you're enabling the correct APIs, then click Enable.
Optionally, to enable the APIs manually:
1. In the Google Cloud console, click Menu > APIs & Services > Enabled APIs & Services.
2. Click + Enable APIs And Services.
3. Search for each required API, click it, then click Enable.

4. Set up authentication and authorization

Authentication and authorization lets the Google Chat app access resources in Google Workspace and Google Cloud necessary to process an incident response, including the ability to create spaces, add people to spaces, post messages to spaces, and create Google Docs documents.

Tip: If you don't know required consent screen information, you can use placeholder information prior to publicly releasing your Google Chat app. In this tutorial, the app is published internally. When you publish it externally, replace placeholder information with real information.

To learn more about authentication in Google Chat, see Authenticate and authorize Chat apps and Google Chat API requests.

In the Google Cloud console, go to Menu > APIs & Services > OAuth consent screen.
Under User type, select Internal, then click Create.
In App name, enter Incident Response.
In User support email, select your email address or an appropriate Google group.
Under Developer contact information, enter your email address.
Click Save and Continue.
Click Add or Remove Scopes. A panel appears with a list of scopes for each API you've enabled in your Google Cloud project.
Select the following scopes:
1. https://www.googleapis.com/auth/chat.spaces.create
2. https://www.googleapis.com/auth/chat.memberships
3. https://www.googleapis.com/auth/chat.memberships.app
4. https://www.googleapis.com/auth/chat.messages
5. https://www.googleapis.com/auth/documents
6. https://www.googleapis.com/auth/admin.directory.user.readonly
7. https://www.googleapis.com/auth/script.external_request
8. https://www.googleapis.com/auth/userinfo.email
9. https://www.googleapis.com/auth/cloud-platform
If you add these scopes manually, click Add to Table.
Click Update.
Click Save and Continue.
Review the app registration summary, then click Back to Dashboard.

5. Create an Apps Script project and connect it to the Google Cloud project

Before creating the Apps Script project, copy your Google Cloud project number. After creating an Apps Script project, you use your Google Cloud project number to connect your Google Cloud project and Apps Script project.

Also, enable the Admin SDK Directory service, which the incident response app uses to get users' display names.

To connect the projects:

Copy your Cloud project number:
1. Go to your Cloud project in the Google Cloud console.
2. Click Settings and Utilities > Project settings.
3. Copy the Project number.
Go to Apps Script.
Click New project. Apps Script creates an untitled project showing a file called `Code.gs`` which consists of a single function. Ignore this file for now.
Rename the Apps Script project:
1. Click Untitled project.
2. In Project title, enter Incident Response Chat app.
3. Click Rename.
In the Chat app Apps Script project, click Project Settings .
Select Show "appsscript.json" manifest file in editor.
Under Google Cloud Platform (GCP) Project, click Change project.
In GCP project number, paste the Google Cloud project number.
Click Set project. The Google Cloud project and Apps Script project are now connected.

To enable the Admin SDK Directory service:

At the left, click Editor code.
At the left, next to Services, click Add a service.
Select Admin SDK API.
In Identifier, select AdminDirectory.
Click Add.

Now that you've created and configured a Google Cloud project and Apps Script project, you're ready to copy the code into your project and run the sample.

6. Copy the code and deploy the Chat app

Rename the file Code.gs to ChatApp.gs.
Replace the template code in the editor with the contents of the files in this sample, including the file appsscript.json. Create new files as needed.
In the file Consts.js, replace the value of the PROJECT_ID with the ID (not the number) of your GCP Project, which you can copy from the Google Cloud Console.
Click Deploy > New deployment.
Click the icon besides Select type and select both Wep app and Add-on.
Name your deployment and click Deploy.
Copy the Deployment ID to use in your Chat app configuration. Copy the Web app URL to access your app later.

The Apps Script app is now deployed.

7. Configure the Chat API

In the Google Cloud Console, search for Google Chat API, and click Google Chat API.
Click Manage.
Click Configuration and set up the Chat app:
1. In the App name field, enter Incident Response Chat app.
2. In the Avatar URL field, enter https://developers.google.com/chat/images/quickstart-app-avatar.png.
3. In the Description field, enter Incident Response Chat app.
4. Under Functionality, select Enable interactive features, Receive 1:1 messages and Join spaces and group conversations.
5. Under Connection settings, select Apps Script project and paste the Deployment ID into the field.
6. Under Slash commands, add a slash command with the name /closeIncident, the ID 1, and give it a description.
7. Under Permissions, select Specific people and groups in your domain, and enter your email.
8. Click Save and refresh the page.
9. On the configuration page, under App status, set the status to Live - available to users.
10. Click Save.

The Chat app is ready to respond to messages.

8. Open the web page

Navigate to the Web app URL from the Apps Script deployment to test your app.