Skip to main content
Connect Outline to Realm to make wiki documents and their file attachments searchable. Navigate to Settings > Data sources and click Connect on Outline, or click Reconnect if already connected.

​
Before you connect

  • An Outline API key that belongs to an Outline admin. Realm needs admin rights to read users, groups, and collection memberships, and to register a webhook.
  • The URL of your Outline workspace, for example https://wiki.example.com.
  • Realm must be able to reach your Outline instance over the network. For live updates, your Outline instance must also be able to send webhooks to Realm.

​
Connecting Outline

In Outline, go to Settings > API and create a new API key. On the Realm data source page, enter your workspace URL and the API key.

​
What gets synced

Changes in Outline reach Realm within about a minute through webhooks. A scheduled full sync reconciles anything a webhook missed.

​
Selecting collections

Every collection the API key can read is synced by default. You can turn individual collections off at any time from the data source page.

​
Permissions

Realm enforces Outline’s native permission model, matched by email address. A document in a workspace-visible collection is visible to all Outline members; a document in a private collection is visible only to the groups and users that collection is shared with. Document-level shares are not synced, so a user who has access to a single document but not to its collection does not see it in Realm. You can override this by switching to “Everyone in this organization” on the data source settings page, which makes the synced collection visible to all Realm users.