The Freshworks API SDK empowers developers to connect with Freshworks products effortlessly through a powerful, OpenAPI-driven client library. Designed for flexibility, it supports integration from external Node.js and serverless Freshworks apps. Simplify API interactions, streamline dev workflows, and unlock the full potential of Freshworks public REST APIs with ease.
Background
Freshworks has several SaaS solutions such as Freshdesk, Freshservice, Freshchat, Freshworks CRM, Freshteam and so on. Each of these product has a developer ecosystem powered by Freshworks Neo Platform. Each of these products offer API documents available for public consumption.
The API Documents are available as part of Freshworks Products API docs respectively available as separate sites as listed below
The API docs are complex and difficult to consume resulting in customer and developer churn. To simplify the consumption and increase faster time to market.
To consume these APIs developer must write equivalent client stub classes and handle the possible edge cases as per API docs. Due to doc complexity consuming APIs becomes hectic and often the edge cases are missed out.
To overcome this problem, we built a custom in house tool for API documentation powered by OpenAPI, Markdoc and React. It utlises modern tech stack and deployment principles with reduced complexity and granular control over the UX and DX of developer docs.
Benefits for Freshworks API SDK
- Improved Developer Experience: Developers can easily find the resources they need, reducing friction in integration and app development.
- Accelerated Adoption: Streamlined resources encourage more developers to adopt and build solutions using Freshworks' APIs and platforms.
- Consistency: A unified solution ensures uniformity in documentation style, quality, and branding across all products.
- Scalability: Supports rapid updates and scalability as Freshworks introduces new APIs, features, and products.
- Collaboration: Enables cross-functional teams (product, support, DevRel) to collaborate on maintaining up-to-date and helpful documentation.
Project Skills and Tools
React
Advanced
Next.js
Advanced
AWS
Intermediate
Markdoc
Intermediate
Swagger
Intermediate