Build ReadMe forms with Paperform

ReadMe is an API documentation platform that helps teams create beautiful, interactive developer documentation.

Paperform connects to ReadMe directly through Stepper workflows.

How ReadMe connects to Paperform

Direct methods run inside your Paperform account. Zapier and Make are there too if your team already uses them.

Stepper workflows

Direct

Run a Stepper workflow when someone submits your form: 10 ReadMe actions and 1 trigger, included in your Paperform account.

  1. Open Stepper from your Paperform account and create a workflow.
  2. Start it with the Paperform “New Submission” trigger and choose your form.
  3. Add a ReadMe step, connect your account and map the submission’s answers to its fields.

ReadMe actions in Stepper

  • Create Changelog Entry
  • Update Changelog Entry
  • Create Doc (Guide)
  • Update Doc (Guide)
  • Create Category
  • Create Custom Page
  • Update Custom Page
  • Find Doc
  • Search Docs
  • Make HTTP Request

ReadMe events that can start a workflow

  • New Changelog Entry

What your form sends to ReadMe

For example, with a Stepper workflow the “Create Changelog Entry” action takes these fields. Map each one to a question on your form, and every submission fills them in.

ReadMe fieldQuestion on your formRequired
TitleShort answerYes
BodyLong answerYes
TypeDropdown or choiceNo
HiddenYes/NoNo

Start from a template

Pick a template, then connect it to ReadMe. There are 30,000+ in the templates directory.

Related

More developer tools integrations

Questions

Bring us the workflow that keeps breaking

Start with the one form whose data never quite lands where it should. Connect the rest when you're ready.

Start building