Skip to main content

Step 1: Install Library

Install the Rollout Link library in your React app:

Step 2: Render component

Choose what data to sync

An entity is a type of data, such as people, notes, or tasks. People sync automatically where supported. The examples below enable optional notes and tasks with entitiesToSync; choose the types your app needs. Alternatively, omit this prop to use the defaults you choose in dashboard Settings. An explicit selection in code takes precedence over those defaults. This configures new connections. For other types or accounts that are already connected, see Choose what data to sync.
Now you should see something that looks like this: A rendering of the Rollout Link UI Component

Step 3 (Optional): Handle when new credentials is added

When a user authenticates with a new credential, you can call a function to handle that interaction. Whether you want to display a new page or store that credential in your database (you can always call the Rollout API to get this data as well). Here is how you would modify the previous code:
If you want to build your own integration cards or connector-specific auth flows, see Build your own integration UI with Rollout Link components. That guide covers:
  • <CredentialForm />
  • <AddCredentialForm />
  • useCredentials()