Friction, Problems and Promise

We are always trying harder to do well at developer experience that we provide to Freshworks App developers. It's only so recently we started focussing in this arena. As much as we are learning from developers, we are trying hard to advocate product teams to optimise certain decisions from platform and product teams for developers.

As you start your journey as Freshworks App developer, not everything may work out on day 1. There are places in your journey where you'd need to sit back and figure out why something is not working as documented. It can also be documentation itself is not clear enough.

Friction Log

This is a method with which you can help us improve. As an insider, we know very little to make decisions and imagine what can be improved. So, we took an initiative for some of you who are reading this and want to help us on this journey by sharing their Friction Log.

A Friction Log is simply a google document that you'd keep with yourself until you build your first 1 or 2 apps on Freshworks Developer Platform. While you build apps, you'd be sometimes feel it's awesome, stuck, frustrated and event quit if it weren't your job. Just log and append them to a Friction Log template I'm about to share you. Add a snapshot of it.

Make a Copy of Friction Log Template and see the example given to keep appending your experience. Make sure the text highlighting is the important part. Or Hey, simply report your feedback.

One you're done logging everything you ever wanted to, attach it and send out an email to [email protected]

Read what we did in 2019

Read how we shaped up on 2020

Here are some quick links that can help you keep moving while you are at it.

Setup & Installation

• How to create and extend a developer account
• What are the prerequisites to install the Freshworks CLI

Platform features

• How to use form-data in Request API?
• Creating ticket with attachments using Serverless apps

Freshworks Developer Kit - FDK

• How to update the FDK to latest version

Troubleshooting

• How to generate HAR file to export and analyze network requests?
• How to obtain debug logs from FDK? Enabling debug mode
• Debugging Front-end apps using Chrome DevTools
• How to obtain serverless logs?
• How to obtain App ID from the Developer Portal?
• Debugging Serverless apps using VSCode and Nodejs Debugger
• How to troubleshoot and resolve issues importing large NPM libraries?

App Publishing & Listing

• App review process to list app on Freshworks Marketplace
• When to use the auto-update feature?

Community practices

• Freshworks developer support for private discussions
• Required information for effective solutioning
• Add tags to highlight your app building stage

Contributions

This guide is intended to get broad idea and help all developers coming on to build apps on Freshworks developer platform. If incase, you don't understand something, the possibilities are that we haven't penned out really well. So, if you have any questions, do create a issue.

Also, along the way, there could be elements where I some mistakes related to content. Or if you are already a seasoned Freshworks developers, we might have missed mentioning things those are important. Feel free to pull request on this repo.