ReadMe

ReadMe hosts a project's developer documentation — API reference, guides, changelog and custom pages.

Authentication

• API key

Actions

Generic API request. Call any ReadMe API endpoint on this connection, for the case where no shipped action covers it yet. The connection supplies the base URL, the authentication and the egress route, so only the path and query are yours to fill.

• List categoriesList the documentation categories for the connected ReadMe project, to resolve a category title to the slug that document actions take.
• List changelogsList the changelog entries published on the connected ReadMe project, most recent first, to find the slug that Get/Update changelog takes.
• List custom pagesList the custom pages on the connected ReadMe project, to find the slug that Get/Update custom page takes.
• List versionsList the documentation versions for the authenticated ReadMe project (GET /version).

Triggers

• New changelogStarts when a new changelog entry is published in ReadMe.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.