Typeform's developer portal

I worked with Typeform’s developers and managers to document three APIs and one SDK.

Typeform helps users create beautiful, conversational online forms. The Typeform platform includes APIs for creating and updating typeforms, programmatically retrieving typeform responses, and pushing responses to URLs and web apps. Typeform also supports an SDK for seamlessly embedding typeforms in websites and web apps.

I was hired to create documentation for a developer portal that would help developers quickly feel at home with Typeform’s platform and start using it to create customized solutions for their own teams. I worked with Typeform’s developers and product managers to document three APIs and one SDK.

Work examples

The developer portal is published at https://www.typeform.com/developers/. Some pages have been updated since I worked on them, but these examples show my work:

• API references:
  • Create form
  • Retrieve responses
  • Retrieve single webhook
  • Delete form
• Walkthroughs:
  • Create API walkthroughs
  • Responses API walkthroughs
  • Webhooks walkthroughs
• User guides:
  • Get started
  • Get hands-on with practice requests
  • Hidden Fields
  • Logic Jumps
  • Recall Information
  • JSON response explanation
  • Example webhook payload
• Conceptual explanations:
  • Create API
  • Responses API
  • Webhooks API
• Procedures:
  • Create applications that integrate with Typeform’s APIs
  • Personal access token for Typeform’s APIs
  • Data portability
• Troubleshooting

OpenAPI Specification files were available as source material for the API documentation. I worked closely with Typeform’s developers and product managers to gather information and validate my drafts. To test endpoints and confirm request bodies and responses, I used Postman and cURL. I wrote the content in Markdown, and all of the documentation files were hosted on GitHub.

Portal site

The docs were deployed to a Gatsby site designed and built by Typeform’s talented designers and developers. Seriously, the site they put together is gorgeous: https://www.typeform.com/developers/. I helped review wireframe designs for the portal site, but I did not design or implement it.

For details about the background story and design decisions for the developer portal, read Step inside our new Developer Platform by Jason Harmon, Typeform’s Chief Platform Officer.

Tools

I used these tools in the course of my work on the Typeform developer portal:

• Git • GitHub
• Markdown
• OpenAPI (aka Swagger)
• Postman
• Snagit