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

Box and RavenDB integration

Plan how Box and RavenDB 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

File or document metadata sync test

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

Starting eventA change involving Box Files or RavenDB Documents needs a defined result in the other system.

  1. Start with Box Files and RavenDB Documents. 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.

What to verifyTest a renamed file, a new version, a moved folder, and an access-restricted document.

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 Box and RavenDB
Box recordRavenDB recordRecord matchingField ownership
FilesProposed record; confirm Stacksync object support.Record matchingDocumentsProposed 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.
FilesProposed record; confirm Stacksync object support.Reporting datasetProposed file or document metadata tableProposed table; choose its name and schema.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.
UsersProposed record; confirm Stacksync object support.Reporting datasetProposed application user or identity tableProposed table; choose its name and schema.Use the immutable user ID within the tenant or directory. Do not equate an application user with a CRM customer contact.Identity and application owners approve account lifecycle and access changes; synchronize only approved attributes.

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.

Box

Connection and object support require review

Record types to review with Stacksync

Record typesCoverage and requirements
  • Files
  • Folders
  • Metadata
  • Collaborations
  • Users
  • Groups
Confirm support for this record type and the direction you need.

Discuss Box requirements

RavenDB

Connection and object support require review

Record types to review with Stacksync

Record typesCoverage and requirements
  • Documents
  • Collections
  • Indexes
  • Attachments
  • Revisions
  • Counters
Confirm support for this record type and the direction you need.

Discuss RavenDB 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 requirementBoxRavenDB
Integration interfaceREST API (api.box.com/2.0), plus the Events API and V2 WebhooksHTTP REST API with official clients (.NET, Java, Node.js, Python, and others)
AuthenticationConfirm the credentials, API plan, and permissions required for Box.Confirm the credentials, API plan, and permissions required for RavenDB.
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

Box
Integration interface
REST API (api.box.com/2.0), plus the Events API and V2 Webhooks
Authentication
Confirm the credentials, API plan, and permissions required for Box.
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 Box account, edition, environment, and business objects the integration must access.
  • Confirm a Stacksync connector or implementation path for Box, including read/write support, authentication, and initial-load limits.
Limitations to check
  • Confirm Stacksync support for Box and the record types your workflow needs.
  • Review write-back, deletion handling, update timing, and account limits with the integration team.
RavenDB
Integration interface
HTTP REST API with official clients (.NET, Java, Node.js, Python, and others)
Authentication
Confirm the credentials, API plan, and permissions required for RavenDB.
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 RavenDB account, edition, environment, and business objects the integration must access.
  • Confirm a Stacksync connector or implementation path for RavenDB, including read/write support, authentication, and initial-load limits.
Limitations to check
  • Confirm Stacksync support for RavenDB and the record types your workflow needs.
  • Review write-back, deletion handling, update timing, and account limits with the integration team.

Prepare Box and RavenDB 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.

Box setup checklist
  • Identify the Box account, edition, environment, and business objects the integration must access.
  • Confirm a Stacksync connector or implementation path for Box, including read/write support, authentication, and initial-load limits.
RavenDB setup checklist
  • Identify the RavenDB account, edition, environment, and business objects the integration must access.
  • Confirm a Stacksync connector or implementation path for RavenDB, 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 Box and RavenDB 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

Record matching

Files / Documents

Compare whether Box Files and RavenDB Documents describe the same file or document metadata in your business.

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

Box
Object support to establish
RavenDB
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

Files / Proposed file or document metadata table in RavenDB (choose its name)

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.

Box
Object support to establish
RavenDB
Your database schema
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

Users / Proposed application user or identity table in RavenDB (choose its name)

Plan a application user or identity dataset while preserving its source meaning.

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

Box
Object support to establish
RavenDB
Your database schema
Record identity
Use the immutable user ID within the tenant or directory. Do not equate an application user with a CRM customer contact.
Field ownership
Identity and application owners approve account lifecycle and access changes; synchronize only approved attributes.

Fields to include

  • Source user ID
  • Tenant reference
  • Account status
  • Group references
Record dependencies
Resolve tenant and group references and establish a protected administrative-account policy.
Validation
Test a renamed login, disabled account, missing group, and a user existing in two tenants.
Recovery
Review access impact before retrying a lifecycle change; reconcile current identity state and retain an approval trail.

Reporting dataset

Tasks / Proposed task or work item table in RavenDB (choose its name)

Plan a task or work item dataset while preserving its source meaning.

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

Box
Object support to establish
RavenDB
Your database schema
Record identity
Use a stable task/work-item ID and preserve its project or parent-ticket reference.
Field ownership
Choose the owner of task status and assignment; destination workflow states may require an explicit transition.

Fields to include

  • Source task ID
  • Parent reference
  • Assignee
  • Status
  • Due date
Record dependencies
Resolve project, user, and parent-item references before the task.
Validation
Test a reassignment, an unsupported status transition, a deleted parent, and a due date across time zones.
Recovery
Reconcile the destination state before retrying a transition to avoid reopening completed work.

Reporting dataset

Events / Proposed event or activity table in RavenDB (choose its name)

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.

Box
Object support to establish
RavenDB
Your database schema
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.

Reporting dataset

Groups / Proposed group or membership table in RavenDB (choose its name)

Plan a group or membership dataset while preserving its source meaning.

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

Box
Object support to establish
RavenDB
Your database schema
Record identity
Keep group IDs and membership relationships separately from group names.
Field ownership
The access owner controls membership; reporting a group is different from granting its permissions.

Fields to include

  • Source group ID
  • Member references
  • Tenant reference
  • Group type
Record dependencies
Resolve user and tenant identities before membership changes.
Validation
Test removed membership, nested groups, and equal group names in different tenants.
Recovery
Recompute the approved membership delta before retrying; do not replay an outdated access grant.

Compare integration approaches

Choose a method around one example record and the update your business needs. Use Files / Documents 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: Keep file/object ID, container, and version. A path can change and a filename can repeat. 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 Box and RavenDB 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 Files / Documents, update direction, account tier, and related-record handling.

Custom API or workflow

Best fit
Consider when Box and RavenDB 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.

File or scheduled snapshot

Best fit
Consider for a one-time Box / RavenDB 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. Distinguish binary files from metadata and links.

Workflow scenarios and expected results

File or document metadata sync test

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

Starting event: A change to the selected Files or Documents record needs a defined result in the other system.

  1. Start with Box Files and RavenDB Documents. 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.

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 Files or Proposed file or document metadata table in RavenDB (choose its name) record needs a defined result in the other system.

  1. Start with Box Files and RavenDB Proposed file or document metadata table in RavenDB (choose its name). 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.

Application user or identity reporting workflow

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

Starting event: A change to the selected Users or Proposed application user or identity table in RavenDB (choose its name) record needs a defined result in the other system.

  1. Start with Box Users and RavenDB Proposed application user or identity table in RavenDB (choose its name). Use the record-matching and field-ownership rules from your mapping worksheet.
  2. Resolve tenant and group references and establish a protected administrative-account policy.
  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 login, disabled account, missing group, and a user existing in two tenants.

If it fails: Review access impact before retrying a lifecycle change; reconcile current identity state and retain an approval trail.

Associate Box documents with RavenDB records

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

Starting event: A document or metadata version in Box is relevant to Documents or Attachments.

  1. Keep the file/object ID, container, version, and related business record ID.
  2. Choose whether the process moves binary content, metadata, or a link. Confirm support for each separately; a metadata row is not a file copy.
  3. Define destination access and how moves, new versions, and deletions are handled without inheriting permissions by assumption.

Expected result: A renamed or versioned file retains the correct business association; an unauthorized record cannot expose document content.

If it fails: Verify current version and access before retrying; reconcile metadata and binary-transfer state independently.

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.

Files / Documents

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.

Files / Proposed file or document metadata table in RavenDB (choose its name)

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.

Users / Proposed application user or identity table in RavenDB (choose its name)

Test case

Test a renamed login, disabled account, missing group, and a user existing in two tenants.

Expected result

The expected application user or identity relationship is preserved with no duplicate action or unintended write.

Tasks / Proposed task or work item table in RavenDB (choose its name)

Test case

Test a reassignment, an unsupported status transition, a deleted parent, and a due date across time zones.

Expected result

The expected task or work item 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 file or document metadata change

Investigate

Inspect Box Files and RavenDB Documents, 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 file or document metadata change

Investigate

Inspect Box Files and RavenDB Proposed file or document metadata table in RavenDB (choose its name), 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 application user or identity change

Investigate

Inspect Box Users and RavenDB Proposed application user or identity table in RavenDB (choose its name), their IDs, and the destination error.

Next action

Review access impact before retrying a lifecycle change; reconcile current identity state and retain an approval trail.

A record type or update is unavailable

Investigate

Check the Box and RavenDB 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 Box and RavenDB

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

Box RavenDB 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 RavenDB.

RavenDB Box 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 Box.

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

Box and RavenDB integration FAQ

Next step

Plan your integration with an engineer

Walk through your Box and RavenDB records, field mappings, and requirements with an integration engineer.