Skip to content
Database / Communications · Two-way sync platform

Citus and Gmail integration

Plan how Citus and Gmail should share data across your business. Work with Stacksync engineers on record mapping, system access, and the requirements for running the integration.

  • Scope your workflow with an integration engineer
  • Review the systems, records, and updates you need
Integration planning
stacksync.com

Built for teams where self-serve, reliability and scale matter

Case study
Migrated from MuleSoft
Case study
Migrated from Celigo
Migrated from Heroku Connect
Migrated from Matillion
Case study
Migrated from Fivetran
Case study
Migrated from Celigo

Proposed workflow

Message or conversation reporting workflow

Planning example. Stacksync support for the required connection and record operations needs a technical review.

Starting eventA change involving the proposed message or conversation table in Citus or Gmail Messages needs a defined result in the other system.

  1. Start with the proposed message or conversation table in Citus and Gmail Messages. Use the record-matching and field-ownership rules from your mapping worksheet.

  2. Resolve conversation, participant, and customer context before associating messages.

  3. Test a normal update and one failed or repeated update in the supported direction. Keep both record IDs with the test results.

What to verifyTest a delivery-state change, repeated message, private conversation, and reply linked to the correct thread.

Review records and field ownership

Proposed record relationships

Records to connect

Use these examples to define record matching and field ownership for your technical review.

Download the mapping worksheet

CSV · No email required

Example record relationships between Citus and Gmail
Citus recordGmail recordRecord matchingField ownership
Proposed message or conversation tableProposed table; choose its name and schema.Reporting datasetMessagesProposed record; confirm Stacksync object support.Retain message ID, conversation/thread ID, channel, and sender identity.Separate message history from actions that send new messages; preserve private/public visibility and channel consent.
Proposed file or document metadata tableProposed table; choose its name and schema.Reporting datasetAttachmentsProposed record; confirm Stacksync object support.Keep file/object ID, container, and version. A path can change and a filename can repeat.Separate document content, metadata, and sharing permissions; a metadata sync does not imply file transfer or ACL replication.
Proposed event or activity tableProposed table; choose its name and schema.Reporting datasetHistoryProposed record; confirm Stacksync object support.Keep the source event ID, source system, occurrence time, and ingestion time. Use an explicit duplicate-detection key.Decide whether the destination stores an immutable history or only a current-state summary.

These relationships do not establish connector availability. Review the required connection and record operations with Stacksync.

Record coverage to review

Use documented coverage where available. Catalog record types are starting points for review and do not confirm Stacksync support.

Citus

Connection and object support require review

Record types to review with Stacksync

Record typesCoverage and requirements
  • Distributed tables
  • Reference tables
  • Local tables
  • Schemas
  • Views
  • Sequences
Confirm support for this record type and the direction you need.

Discuss Citus requirements

Gmail

Connection and object support require review

Record types to review with Stacksync

Record typesCoverage and requirements
  • Messages
  • Threads
  • Labels
  • Drafts
  • Attachments
  • History
Confirm support for this record type and the direction you need.

Discuss Gmail requirements

Connection essentials

Confirm Stacksync support and account requirements for undocumented connections. Interface information alone does not establish connector availability.

View setup requirements and limits
Connection requirementCitusGmail
Integration interfacePostgreSQL wire protocol; any standard Postgres driver connects to the coordinator nodeGmail API (REST, v1)
AuthenticationConfirm the credentials, API plan, and permissions required for Citus.Confirm the credentials, API plan, and permissions required for Gmail.
Change detectionConfirm how Stacksync detects changes for this connector and the objects you need.Confirm how Stacksync detects changes for this connector and the objects you need.
Read accessConfirm with StacksyncConfirm with Stacksync
Write accessConfirm with StacksyncConfirm with Stacksync

Enterprise controls

Security and control for your integrations

Explore security controls

Compliance and data transfers

As a data company, we understand the importance of keeping your data secure. Stacksync is built with security best practices to keep your data safe at every layer, and is DPF-certified for US, EU, UK and CH data transfers.

  • SOC 2 Type II
  • ISO 27001
  • HIPAA BAA
  • GDPR
  • CCPA
  • DPF US-EU-UK-CH

SSO & SCIM

Let your users access Stacksync from your centralized user management systems. Works with Okta, Azure, Google SSO and more.

Alerts

Immediately get alerted about record syncing issues over email, Slack, PagerDuty and WhatsApp. Resolve issues from a centralized dashboard with retry and revert options.

Secure connection options

Record-level recovery

Inspect sync errors and use retry and revert controls to resolve failed updates.

Read the recovery guide

Implementation

Technical reference

Review setup, record relationships, testing, and recovery for your implementation.

Authentication, permissions and API limits

Connection requirements and limits

Citus
Integration interface
PostgreSQL wire protocol; any standard Postgres driver connects to the coordinator node
Authentication
Confirm the credentials, API plan, and permissions required for Citus.
Change detection
Confirm how Stacksync detects changes for this connector and the objects you need.
Read access
Confirm with Stacksync
Write access
Confirm with Stacksync
Setup requirements
  • Identify the Citus account, edition, environment, and business objects the integration must access.
  • Confirm a Stacksync connector or implementation path for Citus, including read/write support, authentication, and initial-load limits.
Limitations to check
  • Confirm Stacksync support for Citus and the record types your workflow needs.
  • Review write-back, deletion handling, update timing, and account limits with the integration team.
Gmail
Integration interface
Gmail API (REST, v1)
Authentication
Confirm the credentials, API plan, and permissions required for Gmail.
Change detection
Confirm how Stacksync detects changes for this connector and the objects you need.
Read access
Confirm with Stacksync
Write access
Confirm with Stacksync
Setup requirements
  • Identify the Gmail account, edition, environment, and business objects the integration must access.
  • Confirm a Stacksync connector or implementation path for Gmail, including read/write support, authentication, and initial-load limits.
Limitations to check
  • Confirm Stacksync support for Gmail and the record types your workflow needs.
  • Review write-back, deletion handling, update timing, and account limits with the integration team.

Prepare Citus and Gmail access

Set up both accounts before testing the mapping. Use test records where available, and identify the account administrator who can approve access and help resolve setup errors.

Citus setup checklist
  • Identify the Citus account, edition, environment, and business objects the integration must access.
  • Confirm a Stacksync connector or implementation path for Citus, including read/write support, authentication, and initial-load limits.
Gmail setup checklist
  • Identify the Gmail account, edition, environment, and business objects the integration must access.
  • Confirm a Stacksync connector or implementation path for Gmail, including read/write support, authentication, and initial-load limits.
Prepare to go live

Record the fields each system can update, the first-load cutoff, both record IDs, the expected update delay, and who handles errors. Complete the tests before production before expanding to more records.

Use the Citus and Gmail planning worksheet to capture these decisions. Record the access owner in the worksheet and enter credentials only in the connection setup.

Talk to an engineer · Review current pricing

Record identity and field ownership

Use these data-model references to describe the records your connection needs. They are planning examples; connector availability and supported operations must be established before implementation.

Download the mapping worksheet · CSV, no email required

Reporting dataset

Proposed message or conversation table in Citus (choose its name) / Messages

Plan a message or conversation dataset while preserving its source meaning.

Planning example. Stacksync support for the required connection and record operations needs a technical review.

Citus
Your database schema
Gmail
Object support to establish
Record identity
Retain message ID, conversation/thread ID, channel, and sender identity.
Field ownership
Separate message history from actions that send new messages; preserve private/public visibility and channel consent.

Fields to include

  • Source message ID
  • Thread reference
  • Delivery state
  • Timestamp
  • Related record ID
Record dependencies
Resolve conversation, participant, and customer context before associating messages.
Validation
Test a delivery-state change, repeated message, private conversation, and reply linked to the correct thread.
Recovery
Check provider delivery state before retrying a send; replaying history must not send the message again.

Reporting dataset

Proposed file or document metadata table in Citus (choose its name) / Attachments

Plan a file or document metadata dataset while preserving its source meaning.

Planning example. Stacksync support for the required connection and record operations needs a technical review.

Citus
Your database schema
Gmail
Object support to establish
Record identity
Keep file/object ID, container, and version. A path can change and a filename can repeat.
Field ownership
Separate document content, metadata, and sharing permissions; a metadata sync does not imply file transfer or ACL replication.

Fields to include

  • Source file ID
  • Container reference
  • Version
  • Metadata
  • Access classification
Record dependencies
Resolve folder/container and parent-record references before attaching metadata.
Validation
Test a renamed file, a new version, a moved folder, and an access-restricted document.
Recovery
Check the current file version and destination access before retrying transfer or metadata updates.

Reporting dataset

Proposed event or activity table in Citus (choose its name) / History

Plan a event or activity dataset while preserving its source meaning.

Planning example. Stacksync support for the required connection and record operations needs a technical review.

Citus
Your database schema
Gmail
Object support to establish
Record identity
Keep the source event ID, source system, occurrence time, and ingestion time. Use an explicit duplicate-detection key.
Field ownership
Decide whether the destination stores an immutable history or only a current-state summary.

Fields to include

  • Source event ID
  • Event type
  • Occurred-at time
  • Related record ID
  • Payload version
Record dependencies
Resolve the related customer, user, or transaction identity without assuming the event ID is the entity ID.
Validation
Deliver the same event twice, then an older event after a newer one; verify duplicate and ordering behavior.
Recovery
Identify side effects already completed before replaying an event; use the agreed deduplication key.

Compare integration approaches

Choose a method around one example record and the update your business needs. Use Proposed message or conversation table in Citus (choose its name) / Messages to review record matching and confirm Stacksync support for the required operations. Compare ongoing sync, a custom workflow, and a scheduled export against that requirement.

Stacksync managed sync

Best fit
Review compatibility with a Stacksync engineer using an example of the records and updates you need.
Operating responsibility
Fits ongoing record synchronization when the required operations are supported. Add workflow steps for approvals or business actions that go beyond copying fields.
Before you choose
Check record matching: Retain message ID, conversation/thread ID, channel, and sender identity. Verify field coverage, deletion handling, and how changes are detected.

Native vendor integration

Best fit
A vendor-built integration may fit if it supports your Citus and Gmail record types.
Operating responsibility
Can reduce setup for a supported workflow. You may need another method for records or business steps it does not cover.
Before you choose
First check whether either vendor offers this integration. If available, verify Proposed message or conversation table in Citus (choose its name) / Messages, update direction, account tier, and related-record handling.

Custom API or workflow

Best fit
Consider when Citus and Gmail need a transformation, approval, or action outside a direct record sync.
Operating responsibility
Provides control over business steps; the team owns credentials, version changes, error queues, and reconciliation.
Before you choose
Verify endpoint permissions, pagination, quotas, duplicate detection, and failure recovery. Separate reading history from actions that send messages, grant access, or post transactions.

File or scheduled snapshot

Best fit
Consider for a one-time Citus / Gmail migration or a reporting need with an explicit freshness window.
Operating responsibility
Can simplify a bounded transfer; later changes and deletion history require another extraction or a separately designed incremental process.
Before you choose
Record the extraction cutoff, source IDs, encoding, date/number formats, and reconciliation totals.

Workflow scenarios and expected results

Message or conversation reporting workflow

Planning example. Stacksync support for the required connection and record operations needs a technical review.

Starting event: A change to the selected Proposed message or conversation table in Citus (choose its name) or Messages record needs a defined result in the other system.

  1. Start with Citus Proposed message or conversation table in Citus (choose its name) and Gmail Messages. Use the record-matching and field-ownership rules from your mapping worksheet.
  2. Resolve conversation, participant, and customer context before associating messages.
  3. Test a normal update and one failed or repeated update in the supported direction. Keep both record IDs with the test results.

Expected result: Test a delivery-state change, repeated message, private conversation, and reply linked to the correct thread.

If it fails: Check provider delivery state before retrying a send; replaying history must not send the message again.

File or document metadata reporting workflow

Planning example. Stacksync support for the required connection and record operations needs a technical review.

Starting event: A change to the selected Proposed file or document metadata table in Citus (choose its name) or Attachments record needs a defined result in the other system.

  1. Start with Citus Proposed file or document metadata table in Citus (choose its name) and Gmail Attachments. Use the record-matching and field-ownership rules from your mapping worksheet.
  2. Resolve folder/container and parent-record references before attaching metadata.
  3. Test a normal update and one failed or repeated update in the supported direction. Keep both record IDs with the test results.

Expected result: Test a renamed file, a new version, a moved folder, and an access-restricted document.

If it fails: Check the current file version and destination access before retrying transfer or metadata updates.

Event or activity reporting workflow

Planning example. Stacksync support for the required connection and record operations needs a technical review.

Starting event: A change to the selected Proposed event or activity table in Citus (choose its name) or History record needs a defined result in the other system.

  1. Start with Citus Proposed event or activity table in Citus (choose its name) and Gmail History. Use the record-matching and field-ownership rules from your mapping worksheet.
  2. Resolve the related customer, user, or transaction identity without assuming the event ID is the entity ID.
  3. Test a normal update and one failed or repeated update in the supported direction. Keep both record IDs with the test results.

Expected result: Deliver the same event twice, then an older event after a newer one; verify duplicate and ordering behavior.

If it fails: Identify side effects already completed before replaying an event; use the agreed deduplication key.

Link communication history with Citus context

This is an evaluation scenario; connector and operation support require confirmation.

Starting event: A communication in Gmail needs an association with a selected destination dataset in Citus.

  1. Select the communication records from Messages or Threads and preserve message/call and thread IDs.
  2. Resolve the participant-to-business-record relationship explicitly; phone number or display name alone may be ambiguous.
  3. Keep history replication separate from sending a message, placing a call, or changing consent. Confirm a separate authorized operation for any action.

Expected result: Repeated delivery updates the same history record; a private conversation stays private; a history replay sends no new message.

If it fails: Check source delivery state and the destination relationship before retrying. Do not resend to repair an analytical or history discrepancy.

Initial load and acceptance testing

Keep both record IDs with the expected and actual result. Reconcile the same filters and time window in each system.

Proposed message or conversation table in Citus (choose its name) / Messages

Test case

Test a delivery-state change, repeated message, private conversation, and reply linked to the correct thread.

Expected result

The expected message or conversation relationship is preserved with no duplicate action or unintended write.

Proposed file or document metadata table in Citus (choose its name) / Attachments

Test case

Test a renamed file, a new version, a moved folder, and an access-restricted document.

Expected result

The expected file or document metadata relationship is preserved with no duplicate action or unintended write.

Proposed event or activity table in Citus (choose its name) / History

Test case

Deliver the same event twice, then an older event after a newer one; verify duplicate and ordering behavior.

Expected result

The expected event or activity relationship is preserved with no duplicate action or unintended write.

Direction and permissions

Test case

Bring an example source record and the intended destination operation to the compatibility review. Confirm the supported route before granting write access.

Expected result

Only an approved, supported direction and permitted fields are written.

Freshness and reconciliation

Test case

Measure source and destination times for the selected records under normal load and a burst. Reconcile IDs and values using the same filters and cutoff.

Expected result

The process meets its agreed freshness target and reconciliation has no unexplained differences.

Failed updates, retries and recovery

Start with the failed record and the destination error, then inspect the source value, field requirements, and access.

Rejected or repeated message or conversation change

Investigate

Inspect Citus Proposed message or conversation table in Citus (choose its name) and Gmail Messages, their IDs, and the destination error.

Next action

Check provider delivery state before retrying a send; replaying history must not send the message again.

Rejected or repeated file or document metadata change

Investigate

Inspect Citus Proposed file or document metadata table in Citus (choose its name) and Gmail Attachments, their IDs, and the destination error.

Next action

Check the current file version and destination access before retrying transfer or metadata updates.

Rejected or repeated event or activity change

Investigate

Inspect Citus Proposed event or activity table in Citus (choose its name) and Gmail History, their IDs, and the destination error.

Next action

Identify side effects already completed before replaying an event; use the agreed deduplication key.

A record type or update is unavailable

Investigate

Check the Citus and Gmail connector guides, account permissions, and any operations marked On Request.

Next action

Ask the integration team to confirm a supported way to handle that record. Verify whether it needs connector configuration or a separate workflow step.

Source and destination disagree after a retry

Investigate

Compare current source values, destination validation, identity mappings, and any side effects already completed.

Next action

Stacksync issue retry reads the current source state. Decide the intended state before retrying or reverting; reconcile downstream effects separately.

Read the Stacksync issues dashboard guide for retry and revert behavior.

Change detection and update delivery

How updates move between Citus and Gmail

See how each system detects changes and which updates the other system can receive. Each direction has its own permissions and record requirements.

Citus Gmail Direction requires confirmation

Detect changesConfirm how Stacksync detects changes for this connector and the objects you need.

Apply updatesConfirm that Stacksync can create or update the records you need in Gmail.

Gmail Citus Direction requires confirmation

Detect changesConfirm how Stacksync detects changes for this connector and the objects you need.

Apply updatesConfirm that Stacksync can create or update the records you need in Citus.

Update timing and record limits
  • Measure initial-load and ongoing-change latency separately. Source detection, selected objects, account limits, and destination validation determine the observed delay.
  • Review write-back, deletion handling, update timing, and account limits with the integration team.
  • Review write-back, deletion handling, update timing, and account limits with the integration team.
FAQ

Citus and Gmail integration FAQ

Next step

Plan your integration with an engineer

Walk through your Citus and Gmail records, field mappings, and requirements with an integration engineer.