DOCSEARCHbyAlgolia
Submit Docs

Rollout Documentation

website·Indexed 33 days ago

https://docs.rollout.com

Developer resources for Rollout, featuring the Universal CRM and Calendar APIs. Includes guides on managing data synchronization, configuring webhooks, styling Auth UI components, and using the CredentialsManager to integrate CRM and TMS connectors.

Tokens
74.8K
Snippets
399
Records
857
Agent score
55%

What's inside Rollout

  1. Overview of Rollout's MCP Server capabilities

    Rollout's MCP server allows AI assistants to connect to CRM systems via a standardized protocol. It exposes a set of CRM tools that enable assistants to:

    • List valid credentials for the authenticated user.
    • Retrieve a person overview from a connected CRM.
    • Create people, notes, and tasks in a connected CRM.

    If multiple valid credentials exist for a user, the credentialId must be provided in the tool input to specify which connected account to use.

  2. Overview of Rollout Universal API

    Rollout is a universal API and embedded authentication layer designed for real estate software. It allows developers to connect to multiple CRMs (e.g., Follow Up Boss, Lofty, CINC), Transaction Management Systems (TMS) (e.g., SkySlope, Dotloop), Loan Origination Systems (LOS) (e.g., Encompass), and email/calendar providers (e.g., Gmail, Outlook) through a single, normalized REST API and a drop-in authentication UI called Rollout Link.

  3. Explore the Rollout Universal API reference application

    Rollout provides a live reference application to demonstrate the capabilities of the Universal API. Note that the current demo implementation supports CRM integrations only; TMS (Transportation Management System) integrations are not yet included.

  4. Understand Sync to DB architecture and ownership

    Sync to DB provides a SQL interface to the same normalized data model used by Rollout APIs. Rollout provisions and manages a hosted Postgres database for your account.

    Ownership and Access Rules:

    • Primary Tables: Managed by Rollout. These must be treated as read-only by the user.
    • User Permissions: You can read/query primary tables and create your own indexes, views, and additional tables.
    • Engine: Postgres.

  5. Understand Rollout End User Terms and Service Definitions

    The Rollout End User Terms govern the use of the Service to enable Integrations that transfer End User Data between a Partner application (e.g., Real Estate CRM, TMS, Mortgage LOS) and a Vendor application.

    Key definitions include:

    • Service: Rollout's proprietary SaaS integration solution, including Integrations, Software, and Documentation.
    • Integration: An API integration that enables data transfer between a Partner and a Vendor. For specific partners like Encompass by ICE Mortgage Technology, this may involve custom code where Rollout acts as a managed service provider.
    • End User Data: Any data transferred to Rollout via an Integration.
    • Vendor: The entity (Rollout's customer) that requires access to End User Data to deliver products or services to the End User.

  6. Implement Rollout Link authentication UI

    Rollout Link is the authentication UI used to enable users to authenticate with their chosen CRM/TMS and create credentials for connected accounts. It should be rendered in your application after you have obtained your API Client ID & Secret and generated a token. Once a user authenticates via Rollout Link, you can use the resulting credential to make API requests.

  7. Choose the appropriate Rollout Link UI component

    Rollout Link provides different levels of customization for the authentication and credential management experience:

    • <CredentialsManager />: Provides the full built-in credential management UI (least custom work).
    • <CredentialForm />: A connector-specific component that handles the credential lifecycle (shows add flow if missing, shows connected credential if present, and supports deletion).
    • <AddCredentialForm />: Renders only the credential creation/auth flow; ideal when the surrounding UI and state are already managed by your app.
    • useCredentials(): A hook to fetch connected credentials, loading states, and errors for building a completely custom list or state-driven UI.

  8. Rollout Architecture Overview

    Rollout acts as a normalization layer between your application and various connected systems (CRMs, TMS, LOS, Email). The architecture consists of:

    • Your Application: Backend (generates JWTs, makes API calls) and Frontend (renders Rollout Link).
    • Rollout Platform: Auth Service, Universal API (normalized REST interface), Webhook Service (real-time events), and Sync to DB (continuous Postgres sync).
    • Connected Systems: The third-party integrations providing raw data.

  9. Understand data roles for Rollout Workflows

    When using Rollout to create automated workflows, data responsibility is split between the User and Rollout:

    • User (Data Controller): The user is the data controller for 'Workflow Content' (data transferred in and out of automated workflows). Users are responsible for safeguarding this content and ensuring workflows/integrations do not trigger or process user data without proper consent.
    • Rollout (Data Processor): Rollout acts as the data processor, responsible for safeguarding Workflow Content as it flows through Rollout's systems.

  10. Monitor platform health via Dashboard SLA view

    Enabled tenants can now access a Dashboard SLA view to monitor the following platform metrics:

    • Platform uptime
    • Auth availability
    • API latency
    • Credential connection latency
    • Webhook queue latency

  11. Understand Rollout connection authentication methods

    Rollout supports three primary ways to connect existing CRMs or business systems to its powered products:

    1. API key or token: The user copies a credential from their CRM settings and pastes it into a secure connection form.
    2. Secure OAuth sign-in: The user signs into their CRM via a secure popup window, selects the correct account, and approves access.
    3. CRM login: The user enters the same account credentials (email/password) used to sign into their CRM directly.

    Note: The connection screen may be white-labeled with the name and colors of the specific product being used, but the authentication steps remain the same.

  12. Understand Rollout's built-in security enforcement

    Rollout implements several native security controls to protect credentials and data integrity:

    • Server-side token minting: Ensures that Client Secrets are never exposed to the browser.
    • Signed webhooks: All events are signed using HMAC SHA256, allowing users to verify the authenticity of requests via the X-Rollout-Signature header.
    • Credential scoping: API requests are strictly scoped to the specific credentialId provided in the request.