Connect ReadMe and GitHub to Build Intelligent Automations

Choose a Trigger

ReadMe

When this happens...

Choose an Action

GitHub

Automatically do this!

Ready to use ReadMe and GitHub 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 Issue Created

New Issue Created

Runs when a new issue is created.

New Branch or Tag Created

New Branch or Tag Created

Runs when a new branch or tag is created.

New Release Published

New Release Published

Runs when a new release is published in the selected repository.

Pull Request Opens or Closes

Pull Request Opens or Closes

Runs when PR opens or closes

New Comment Added to Issue

New Comment Added to Issue

Runs when a new comment is added to an issue.

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 Issue

Create Issue

Creates a new issue in a specified repository.

Need help building your workflow?

Get instant answers from our AI assistant or connect with a support specialist anytime.

Frequently Asked Questions

How do I start an integration between ReadMe and GitHub?

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

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

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

How often does the data sync between ReadMe and GitHub?

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

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

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

About GitHub

GitHub is a platform for version control and collaboration, allowing developers to work together on projects from anywhere. It provides tools for code review, project management, and continuous integration.

Learn More