Gmail
Pull threads, messages, and labels from a connected Gmail mailbox so you can triage email inside Atlas.
What this connector does
- Pull individual mailbox threads, messages, and labels for the connected user.
- Convert any thread into an Atlas task with the original email preserved as context.
- Sync read state and starred state back to Gmail so the mailbox stays in sync.
- Watch for new messages with a label-scoped poll so triage runs in near real time.
Before you begin
- You are an admin in the Google Cloud project used for the OAuth client.
- You can edit the Atlas tenant Integrations settings.
- You have a sandbox Google account to validate the first connection before rolling out.
Get your credentials
Open the Google Cloud console
Sign in with an admin account that owns the Cloud project Atlas will use. console.cloud.google.com
Create an OAuth 2.0 Client ID
In APIs and Services, open Credentials, then create an OAuth client of type Web application. APIs and Services, Credentials
Add the Atlas redirect URL
In Authorized redirect URIs add https://YOUR-ATLAS-HOST/oauth/callback/gmail. Replace YOUR-ATLAS-HOST with the host serving Atlas.
Enable the Gmail API
In APIs and Services, Library, search for Gmail API and enable it for this project. Enable Gmail API
Copy the client id and secret
Open the OAuth client you created and copy both values. Paste them into the Atlas Gmail connector settings page and click Save.
Required scopes and permissions
https://www.googleapis.com/auth/gmail.readonlyhttps://www.googleapis.com/auth/gmail.modifyopenid email profileSetup checklist
- Create the provider app in a sandbox or development workspace.
- Add the Atlas redirect URL to the provider app configuration.
- Copy the client id, client secret, or API key.
- Paste the credentials into the Atlas connector settings page.
- Click Connect and complete the provider sign-in screen.
- Run Test connection from the connector page to verify health.
Troubleshooting
redirect_uri_mismatch
The redirect URI in the OAuth client must exactly match the one Atlas advertises, including https and trailing slash.
access_denied during consent
Confirm the test user is added under OAuth consent screen, Test users, while the consent screen is still in Testing.
invalid_scope
The Gmail API was not enabled on the project. Enable it in API Library and retry.
Webhooks
Gmail uses a polling watch rather than push webhooks. Atlas runs a labeled-sync poll on the connected mailbox.
Events Atlas listens for
- New message in INBOX
- Label added or removed
- Message marked read or starred
Disconnect and data deletion
- Click Disconnect on the Atlas Gmail connector page to revoke the refresh token.
- Open https://myaccount.google.com/permissions and remove the Atlas app for the connected account.
- Atlas deletes the locally cached thread metadata for that user within 24 hours of disconnect.
Once you have the credentials above, paste them into the live connector page to finish connecting Gmail.
Open the Gmail connector page