Connect ReadMe and outline to Build Intelligent Automations

Choose a Trigger

ReadMe

When this happens...

Choose an Action

outline

Automatically do this!

Ready to use ReadMe and outline automations

Actions and Triggers

When this happensTriggers

A trigger is an event that starts a workflow.

Updated branches

Updated branches

Retrieve branches updated in the last N minutes.

New Document Published

New Document Published

Triggers when a new document is published.

Collection Created

Collection Created

Triggers when a new collection is created in outline account.

Document Created

Document Created

Triggers when a new document is created in outline account.

Group Created

Group Created

Triggers when a new group is created in outline.

Stars Created

Stars Created

Triggers when a document or collection is starred.

Do thisActions

Action is the task that follows automatically within your ReadMe integrations.

Show documentation branches

Show documentation branches

Show all documentation branches and their base, privacy, release stage, and last updated time.

Create documentation category

Create documentation category

Create a new documentation category in the selected branch and section.

Update category

Update category

Update a category's title, sidebar position, or section in the selected ReadMe branch.

Create custom page

Create custom page

Create a documentation page in a selected project version by setting the title, URL slug, content, appearance, SEO metadata, and visibility.

Upload image

Upload image

Add an image to your ReadMe documentation.

Create Document

Create Document

Creates a document in outline.

We'll help you get started

Our team is all set to help you!

Customer support expert avatarTechnical support expert avatarAutomation specialist expert avatarIntegration expert avatar

Frequently Asked Questions

How do I start an integration between ReadMe and outline?

To start, connect both your ReadMe and outline accounts to viaSocket. Once connected, you can set up a workflow where an event in ReadMe triggers actions in outline (or vice versa).

Can we customize how data from ReadMe is recorded in outline?

Absolutely. You can customize how ReadMe data is recorded in outline. This includes choosing which data fields go into which fields of outline, setting up custom formats, and filtering out unwanted information.

How often does the data sync between ReadMe and outline?

The data sync between ReadMe and outline typically happens in real-time through instant triggers. And a maximum of 15 minutes in case of a scheduled trigger.

Can I filter or transform data before sending it from ReadMe to outline?

Yes, viaSocket allows you to add custom logic or use built-in filters to modify data according to your needs.

Is it possible to add conditions to the integration between ReadMe and outline?

Yes, you can set conditional logic to control the flow of data between ReadMe and outline. For instance, you can specify that data should only be sent if certain conditions are met, or you can create if/else statements to manage different outcomes.

ReadMe

About ReadMe

ReadMe is a comprehensive platform designed to help businesses create, manage, and share API documentation effortlessly. It offers tools for interactive documentation, user guides, and developer portals, enhancing the developer experience and streamlining communication.

Learn More
outline

About outline

Outline is a fast, open‑source team knowledge base and wiki for organizing internal documentation, product specs, support answers, meeting notes, and onboarding. It features a blazing‑fast Markdown editor with slash commands, real‑time collaboration with comments and threads, powerful search with optional AI answers, and 20+ integrations including Slack, Figma, and Loom. Teams can manage permissions, guest access, and public sharing, and customize branding with custom domains; it’s available both as a hosted cloud service and a self‑hosted deployment. Designed for speed, simplicity, and transparency, Outline serves as a shared long‑term memory for modern teams.

Learn More