Connect ReadMe and Shortcut to Build Intelligent Automations

Choose a Trigger

ReadMe

When this happens...

Choose an Action

Shortcut

Automatically do this!

Ready to use ReadMe and Shortcut 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 Category

New Category

Triggers when a new Category is Created.

New Story

New Story

Triggers when a new Story is Created.

New Epic

New Epic

Triggers when a new epic is created.

New Label

New Label

Triggers when a new label is created.

Request a new Trigger for ReadMe

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.

List custom pages

List custom pages

List all custom pages in the selected project branch.

Upload image

Upload image

Add an image to your ReadMe documentation.

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 Shortcut?

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

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

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

How often does the data sync between ReadMe and Shortcut?

The data sync between ReadMe and Shortcut 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 Shortcut?

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 Shortcut?

Yes, you can set conditional logic to control the flow of data between ReadMe and Shortcut. 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
Shortcut

About Shortcut

Shortcut is a project management tool designed to help teams plan, collaborate, and track their work efficiently. It offers features like task management, workflow automation, and team collaboration to streamline project execution.

Learn More