Controlling Which Records Sync with Rollout

Rollout distinguishes between core entities (always synced) and opt-in entities (synced only if specified). This gives you flexibility to minimize data sync to just what you need, per integration.

Core and Opt-In Entities by Category

Category	Core Entities	Opt-In Entities
CRM	users, people	e.g. tasks, notes, calls, etc
TMS	users, people, transaction	e.g. tasks, offices, etc
LOS	users, people, loans	e.g. borrowers, properties, etc

Core entities are always kept in sync.
Opt-in entities must be explicitly enabled.

How to Sync Opt-In Entities

To sync additional (non-core) entities, use the entitiesToSync prop on the CredentialsManager component.

Example: Syncing Tasks

React Example:

<CredentialsManager entitiesToSync={{ tasks: true }} />

Vue Example:

mounted() {
  fetch("/rollout-token")
    .then((resp) => resp.json())
    .then((data) => data.token)
    .then((token) => {
      // ... setup code ... //
      import(/* webpackIgnore: true */ "https://esm.sh/@rollout/link-react@latest?bundle=all").then(
        ({ RolloutLinkProvider, CredentialsManager, createElement, createRoot }) => {
          this.rolloutRoot = createRoot(this.$refs.rolloutContainer);
          this.rolloutRoot.render(
            createElement(
              RolloutLinkProvider,
              { token },
              createElement(CredentialsManager, {
                entitiesToSync: { tasks: true }
              })
            )
          );
        }
      );
    });
}

Note:

You can add any supported entity as a key in the entitiesToSync object (e.g., { tasks: true, notes: true }). Only entities marked as true will be included in the sync process.