Gmail setup guide

Agents read conversations and write messages for your company. Anything a customer or the public sees, such as a sent email or a posted message, is tier 3, so it asks first unless you decide otherwise.

Ways to connect

Company admins connect apps, on the Integrations page in Everdeck: open Gmail, choose one of the ways below, follow its steps and fill in its fields. Everdeck checks what you enter before it saves anything, and asks you to confirm it’s you (your second factor) before you type any secret. How connecting works.

Your Google Cloud OAuth client

Your OAuth app.

This way signs in with an OAuth app you create for Gmail, as its steps describe: Everdeck never uses an app of its own. Register this redirect URI with your app:

https://everdeck.io/api/oauth/callback

Then save the app’s client ID and secret in Everdeck, on the connect page or under OAuth apps, and sign in.

1. In Google Cloud console, pick or create a project, open https://console.cloud.google.com/apis/library/gmail.googleapis.com and click Enable.
2. Open https://console.cloud.google.com/auth/branding and set the app name and support email. Under Audience, choose Internal if the mailbox belongs to your Google Workspace: no Google review is needed and access doesn't lapse. With External, keep the mailbox listed as a test user and note that Google ends test-mode access every 7 days until you publish the app.
3. Under Data Access, add the scope https://www.googleapis.com/auth/gmail.modify.
4. Under Clients, create an OAuth client of type "Web application" and add the authorized redirect URI https://everdeck.io/api/oauth/callback.
5. Copy the Client ID and Client secret into the form, click Connect, and sign in as the mailbox the agent should use (a dedicated mailbox for the agent works best).

The scopes Everdeck asks for:

• https://www.googleapis.com/auth/gmail.modify

When you disconnect, Everdeck asks Gmail to revoke the sign-in, then deletes the tokens it saved.

What agents can do

An agent uses an action only when its charter grants it, on the agent’s Tools tab, where you choose whether each one runs by itself (Auto), asks first or never runs. Each action has a risk tier: tier 3 actions, which customers or the public see, ask first unless you choose otherwise, and tier 4 actions (money, deleting things, access) always need a person. How tools and tiers work.

Actions marked Reads outside content return things people outside your company may have written. Agents treat what they read as information, never as instructions, and their riskier actions later in the same session need approval.

• Search emailTier 0 · ReadReads outside contentgmail_search_messages

  Find messages with Gmail search syntax (from:, to:, subject:, is:unread, label:, has:attachment, newer_than:2d, in:inbox). Returns each message's id, thread id, from, to, subject, date, snippet and labels, newest first.

• Read an emailTier 0 · ReadReads outside contentgmail_get_message

  Read one message: headers, the plain-text body (HTML converted to text when there is no text part), labels, and the attachment list (filename, type, size, attachment_id).

• Read a conversationTier 0 · ReadReads outside contentgmail_get_thread

  Read every message in a thread, oldest first, with bodies as plain text.

• Download an attachmentTier 0 · ReadReads outside contentgmail_get_attachment

  Save one attachment of a message to the company's files and return the file reference.

• List labelsTier 0 · ReadReads outside contentgmail_list_labels

  List system and custom labels with their ids, for use with modify_labels and label:name searches.

• Send an emailTier 3 · ExternalReads outside contentgmail_send_message

  Send a new email from the connected mailbox. Body is plain text; add html_body for formatted mail. Attachments are files from the company's files.

• Reply to an emailTier 3 · ExternalReads outside contentgmail_reply_to_message

  Reply in the same thread. Replies to Reply-To (or From); with reply_all, also copies the other To and Cc recipients. Subject and threading headers are set automatically.

• Draft an emailTier 2 · ReversibleReads outside contentgmail_create_draft

  Save a draft for a person to review and send. Set reply_to_message_id to draft a reply in that thread; otherwise to and subject are required.

• Send a draftTier 3 · Externalgmail_send_draft

  Send an existing draft exactly as saved.

• Label, archive or mark readTier 2 · Reversiblegmail_modify_labels

  Add or remove label ids on a message. Archive = remove INBOX; mark read = remove UNREAD; star = add STARRED. Use list_labels for custom label ids. TRASH can't be added: deleting email is not part of this connector.

What can start work

These events from Gmail can become tasks for your agents through Intake. How Intake works.

A new email arrived in the inbox.

Connect Gmail first. Then, on the Intake page, open Webhooks and sources, find it under Connector triggers and select Start watching. Then, on the Rules tab, select New rule to say which requests become tasks and who gets them.

Testing, problems and disconnecting

Everdeck checks the connection when you save it. On the connection’s page in Integrations, Test checks it again at any time.

If Gmail later refuses the connection, for example because a key was deleted or a sign-in expired, the connection shows Needs attention on the Integrations page and the people who manage connections are told. Agents can’t use it until a company admin fixes it with Edit or Reconnect.

To stop agents using Gmail, open the connection and select Disconnect. Agents stop using it at once and its saved credentials are deleted. What else happens depends on how it was connected: each way above says.