freshworks / marketplace-sample-apps Goto Github PK

Description of the enhancement:
We try adding working gifs or screenshots if a app can be run. But we missed this time adding necessary to Sample CRM App example.

Would you be interested to run the app and add the relevant gifs / screenshots by creating a screenshots folder in the directory?

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Resources

• How you quick start & run the app?
  

Description of the enhancement:
We need to convert ES6 code to ES5 in these two javascript files
https://github.com/freshdesk/marketplace-sample-apps/blob/master/Freshdesk/v2/instance_api_app/app/app.js

https://github.com/freshdesk/marketplace-sample-apps/blob/master/Freshdesk/v2/instance_api_app/app/modal.js

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Describe the solution you'd like
let keyword, => arrow functions, etc are part of ES6. The code in the above-mentioned scripts is not ES5 compliant. This needs to be modified to be ES5 compliant

Reason
We want to extend our support of sample apps to legacy browsers as it will be used by mid-market and enterprise customers as well.

Please follow the contributing guidelines before raising the PR :) !!

Happy Hacking! 🎃♥️

Description of the enhancement:
The README should state in BOLD terms we do not support this version of the platform anymore. In addition, all READMEs of all sample apps in this folder must state the same.

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Describe the solution you'd like
Same as described above.

Describe the sample app use-case :
The existing sample app - https://github.com/freshdesk/marketplace-sample-apps/tree/master/Freshdesk/v2/simple_request_app - is a good way to learn how to use the Request API feature, but most app developers will end up trying to make Request API calls to Freshdesk. There should be a sample that focuses mainly on this very common use-case.

For which product ? :

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Do you already have a sample app / PR ready? :
No

More details :
The sample app could have a simple UI that, given a ticket-id, fetches details about the ticket and displays the summary, status and assignee details inline.

I've set up OAuth with FB, the authorization flow works well and I'm able to find the access token in .frsh/localstore file.
Although I am unable to get the value in my app.js when making an external request.

Description of the enhancement:
From last few weeks, we started working to add some code comments adhering to JSDoc standards.

Expectation
For example comments as in this piece of code.

Current version
Twilio_sms sample app's code is one of those not yet commented.

Would you be interested in understanding the code and giving it a try?

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Helpful Resources

1. Basic app building quick start.
2. The documentations to Server method invocation and Interface API.

Describe the sample app use-case :
Freshsales has a small quirk (currently) with respect to its Data APIs giving very little information (mainly just an ID) about the entity in question. This means an app must make a REST API to fetch additional details. Freshsales REST APIs are also ever so slightly different. A sample app that fetches details about the current Lead (the page where it loads) and displays basic details - first name, last name, email and city - would be super helpful.

For which product ? :

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Do you already have a sample app / PR ready? :
No

Describe the bug
Every sample app is expected to have a screenshot of the app. Freshdesk/your_first_app has a readme.md file which displays screenshot of an older version of the app while code is updated.

Can you run the app and add correct screenshot?

Noted in which product sample app

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Resources

• How you quick start & run the app?
  

Hi Raghu,

I am developing zoom app, which uses OAuth feature. access_token is getting expired when the app is idle for some time.

When I validate the code using frsh validate (SDK v1) command, I get the below error
Unexpected token T in JSON at position 0

Describe the bug
receiving the following error when running the onTicketCreate event
server.js:836
var needle = (cov_21fw1getpg.s[0]++, loadDependency('needle'));
^

ReferenceError: loadDependency is not defined
at server.js:836:34
at server.js:974:22
at Script.runInContext (vm.js:133:20)
at ProductEvent.sandboxExecutor (...\nvm\v10.18.0\node_modules\fdk\lib\event_handler\framework.js:223:25)
at require (...\nvm\v10.18.0\node_modules\fdk\lib\event_handler\framework.js:110:27)
at server.js:565:39
at server.js:675:22
at Script.runInContext (vm.js:133:20)
at ProductEvent.sandboxExecutor (...\nvm\v10.18.0\node_modules\fdk\lib\event_handler\framework.js:223:25)
at handler (...\nvm\v10.18.0\node_modules\fdk\lib\event_handler\framework.js:341:31)
server.js:836
var needle = (cov_21fw1getpg.s[0]++, loadDependency('needle'));

Link to the bug'd Sample App
link

To Reproduce
Steps to reproduce the behavior:

• run fdk

• Add api key in install

• simulate onTicketCreateEvent at http://localhost:10001/web/test#

• See error in command line

Expected behavior
Create a ticket, followed by a merge when a second ticket is created.

Browser (please complete the following information):
Chrome

Additional context
Add any other context about the problem here.

Description of the enhancement:
It's a request for a change in the readme file for an existing app.
In the readme file of the Advanced data storage app, there is a list of platform features mentioned which have been used in the app. It would be nice to add links to these features listed with the relevant feature's link from our developer documentation.

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Resources

• Developer documentation

Description of the enhancement:
In the server.js file of the external events app, the request NPM package has been used instead of the Request API of our platform. It would be great to remove the request NPM package dependency and replace it with the Request API of our platform.

The Request API feature of our platform is similar to the request NPM package, so the usage of the feature should be familiar.

Why this change?

1. It is recommended to use most of the platform features for the integrations of Freshworks products as the developer need not to worry about the maintainability and scalability concerns which are taken care by the platform.
2. The Request API feature of the platform works as a proxy to address CORS.
3. API Keys, token and other sensitive information from the Installation parameters can be used securely in the API.

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Resources

• Documentation of Request API of the platform

Describe the bug
Tried running the React demo app with fdk pack, it throws following error

[himank@himank-pc react_todo_app]$ fdk pack
Packing failed due to the following issue(s):
[ERROR] app/app.js::6: Parsing error: Unexpected token <

Link to the bug'd Sample App
URL

To Reproduce
Steps to reproduce the behavior:

1. Clone this repo
2. Navigate to react_todo_app directory
3. Type fdk pack in terminal

Expected behavior
The pack command would generate the dist/react_todo_app.zip file which we can upload in the Developer portal to be published in Freshdesk Marketplace.

Screenshots
https://i.imgur.com/qbPFoBa.png

Browser (please complete the following information):
Chrome

Additional context
We are using the same code base to create an app with react, but not able to run fdk pack successfully there, same issue "Unexpected token <"

Describe the sample app use-case :
It would be an encouraging experience for Agents if FChat makes some encouraging statements whenever Agent resolves the conversation.

• You did a great job! Agent Name .

• Customer Name is a happy customer now!

• You have exchanged Number of Messages Messages with this customer! Kudos!

• Fee free to think more add your own. At Least 10 such phrases.

Demonstrated features
This is a single app that will cover all the basic features of the platform for freshchat.

• Use conversation_background to have the app running in the background.
• Interface method to show in product notification.
• Data method to substitute details inside notifications.
• Events method to show trigger js method when conversation is marked resolved

Hi,

I'm trying to run the simple_request_app example code but I'm getting the following error:

Mixed Content: The page at 'https://homewizard.freshdesk.com/helpdesk/tickets/1010' was loaded over HTTPS, but requested an insecure XMLHttpRequest endpoint 'http://localhost:10001/dprouter'. This request has been blocked; the content must be served over HTTPS.

The code is running on my local machine via the Chrome extension. Does anyone know how to fix this?
It seems to be a problem with HTTP and HTTPS but I can't find any issues in the code.

Thanks
Michel

To my freshdesk app, I am Using OAuth based authentication.
My third party API wants to send client_id along with autherization_url like "authorize_url": "https://login.teamviewer.com/oauth2/authorize?response_type=code&client_id=<%= oauth_iparams.client_id %>&redirect_uri=http%3A%2F%2Flocalhost%3A10001%2Fauth%2Fcallback"
but in freshdesk underscore template doesnot support in "authorize_url". and "token_url";

Can please give me suggestion on how to over come this problem.

Description of the enhancement:
The handle-response.js in the lib directory is not used. We can remove it

https://github.com/freshdesk/marketplace-sample-apps/tree/master/Freshdesk/v2/your_first_serverless_app/server/

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Describe the solution you'd like
Remove handle-response.js at https://github.com/freshdesk/marketplace-sample-apps/tree/master/Freshdesk/v2/your_first_serverless_app/server/lib/

Description of the enhancement:
From last few weeks, we started working to add some code comments adhering to JSDoc standards.

Expectation
For example, comments as in this piece of code.

Current version
Ticket Top navigation sample app's code is one of those not yet commented.

Would you be interested in understanding the code and giving it a try?

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Description of the enhancement:
Developers you open Freshdesk folder don't know what is v1 and v2. We require a simple Readme.md file which tells the developers the differences and 2-4 point description.

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Description of the enhancement:
The code at https://github.com/freshdesk/marketplace-sample-apps/blob/master/Freshdesk/v2/your_first_app/app/app.js contains arrow functions that are not ES5 compliant

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Describe the solution you'd like
The front-end code has to be ES5 compliant.

Reason
As a part of mid-market and enterprise move, we might stumble on legacy browsers. It is good to have client-side code in ES5

Description of the enhancement:
The coverage folder and .report.json file has to be removed from the following apps

1. https://github.com/freshdesk/marketplace-sample-apps/tree/master/Freshservice/conditional_ticket_properties
2. https://github.com/freshdesk/marketplace-sample-apps/tree/master/Freshservice/onclick_alerts
3. https://github.com/freshdesk/marketplace-sample-apps/tree/master/Freshservice/show_ticket_and_associated_details (Just .report.json)
4. https://github.com/freshdesk/marketplace-sample-apps/tree/master/Training/customer_interactions_app (Just coverage)
5. https://github.com/freshdesk/marketplace-sample-apps/tree/master/Training/data_storage (Just coverage)

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Describe the solution you'd like
The coverage folder and .report.json file will be generated when they run the app and should not exist in the repo. Kindly remove them from the mentioned repos. Sometimes there maybe coverage folder and not .report.json in which case, proceed to removing the coverage folder alone

Description of the enhancement:
Add a empty span tag with class content below https://github.com/freshdesk/marketplace-sample-apps/blob/master/Freshdesk/v2/your_first_app/app/template.html#L12

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Reason
The controller logic tries to set the content for this tag that you can see here

Description:
Link to codelabs is missing for the fundamental track apps. If you go to https://github.com/freshdesk/marketplace-sample-apps/tree/master/Training/fundamentals, it lists the apps for all three levels. However, it is missing the link to http://freshhuddle.github.io

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Describe the solution you'd like
Add a simple README at https://github.com/freshdesk/marketplace-sample-apps/tree/master/Training/fundamentals pointing to http://freshhuddle.github.io

Describe the sample app use-case :
FullContact's Enrich API offers a lot of public profile details at Person level. This can help agent customize the conversation based on customers interests at Person level and not at Company level.

Features to Demonstrate
This app should demonstrate 3 Advanced Features of the Platform

• Request method to reach FullContact's above mentioned endpoint and get the needed payload.
• Data Storage to store last 5 lookups performed and delete remaining.
• Instance Method to get the required details to make a call from conversation_user_info placeholder and display the Person details in a Modal.

More details :
This endpoint requires email, twitter_id and FullName to send you required details about the person.

Describe the bug
In the Freshservice Samples, see Readme file has Features mispelt.

Describe the sample app use-case :
Imagine you are an Business Event collecting form submissions from the attendees at the Stall. It's highly likely that you may want to collect these leads and follow up via a CRM. This app lets you sync all the submissions as leads on Freshsales CRM every few intervals.

Features Demonstrated

• Serverless Feature - Scheduled Events to stick with time intervals.
• Interact with Freshsales API to create the Leads.
• [Advanced] Show the status of Leads created vs Leads yet to synced in lead_details_page placeholder.

Do you already have a sample app / PR ready? :
Yes/No

More Hints :

1. Each Airtable(base) has unique API endpoints.
2. Have at least 5 Airtable form attributes.
3. Feel free to adjust schedule based on the rate limits set by Airtable. But should be justifiable.

Describe the bug
In this sample app, there is dist/ folder which is not needed.

Description of the enhancement:
The freshservice github workflow actions app currently doesn't have a Readme.md file.

Would you be interested to learn about it and add a Readme.md file?

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Describe the bug
The sample_crm_app for Freshdesk fails due to the app using Basic Auth for Freshsales API. Fix is required to access the Freshsales APIs

Noted in which product sample app

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

To Reproduce
Steps to reproduce the behavior:

1. Do a 'fdk run' on the sample_crm_app with correctly configured iparams_test_data.json
2. Load your Freshdesk URL with ?dev=true appended to it (https://developers.freshdesk.com/v2/docs/quick-start/)
3. View the 'Ticket Details' page and find the app loaded
4. See error 'Error searching CRM database' as a notification

Expected behavior
App should not throw 'Error searching CRM database' with correctly configured test-data

Browser (please complete the following information):
Chrome/Safari/ Firefox etc.

Additional context
Authentication for Freshsales --> https://www.freshsales.io/api/#intro

Describe the sample app use-case :
OAuth Installation Parameters is an advanced feature that can benefit from a sample app. There is a training app here that could be used as a baseline and built upon.
https://github.com/freshdesk/marketplace-sample-apps/tree/master/Training/shopify_oauth_app

For which product ? :

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Do you already have a sample app / PR ready? :
No

More details :
Build upon the training app above.

Description of the enhancement:
The FreshCaller sample app (the only one currently) does not have a detailed README describing the use-case, what it teaches and screenshots - the usual standard content we expect in our READMEs.

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Describe the solution you'd like
README should be on par with other READMEs (see the Freshdesk folder for good examples).

Description of the enhancement:
Currently, the README for sample apps at https://github.com/freshdesk/marketplace-sample-apps/tree/master/Freshchat is pointing to each sample app. It would be nice to have a short description for each of the sample app there itself.

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Description of the enhancement:
In the show_ticket_and_associated_details sample app, the coverage folder is accidentally added in the directory which is not needed in the scope of sample apps repo.

Will you be able to remove it?

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Description of the enhancement:
It's a request for a change in the readme file for an existing app.
In the readme file of the GitHub Issues external events app, there is a list of platform features mentioned which have been used in the app. It would be nice to add links to these features listed with the relevant feature's link from our developer documentation.

Note:

• Adding links only to the platform features is enough
• Add the link of the Installation parameter section from the documentation for the secure installation parameter platform feature in the list.

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Resources

• Developer documentation

Description of the enhancement:
The idea is to have a consistent README for developers who land on sample apps repo. Would require suggestions from all. I have added the format in the issue below

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Describe the sample app use-case :
Webhook enables you to send lead form data to your CRM system in real-time. Freshworks Developer Platform enables you to create a webhook and capture lead data and store it in Freshsales CRM

More details :
Please use External Events platform feature and make API calls to freshsales. This features in Google Ads is still in beta version, please feel free to add comments if something doesn't work.

Describe the sample app use-case :
An app where user can turn pomodoro on. Focus for 25 min and break 5 min using Scheduled events and Interface API for notifications

For which product ? :
Freshservice

Do you already have a sample app / PR ready? :
No

More details :

1. App can be placed on any Agent facing app location. Feel free to chose the location that makes more sense to you.
2. It may not need to have a lot of customisation options as it's just a sample.
   3.a. Just have a button to trigger scheduled event of 25 min.
   3.b. Once 25min is complete, it should show a notification using interface API asking to take a 5 min break.
3. [Optional]You may look at pomodoro apps on web to explore more options/customizations that you may want to add.

Description of the issue:

The console.log statement at line 34 and 114 of app.js has to be removed.

https://github.com/freshdesk/marketplace-sample-apps/blob/master/Training/fundamentals/level2/app/app.js#L34

https://github.com/freshdesk/marketplace-sample-apps/blob/master/Training/fundamentals/level2/app/app.js#L114

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Hello, Freshdesk team!

I receive an error when I try to Validate / Pack the Example serverless_request_app.

Steps to reproduce:

1. Clone the repository
2. Navigate to serverless_request_app (No change is made in the Application's code)
3. Run in terminal fdk validate / fdk pack
4. Error is displayed:

$ fdk pack
Packing failed due to the following issue(s):
The following dependencies are not used: request

$ fdk validate
Validation failed due to the following issue(s):
The following dependencies are not used: request

Environment:

$ node -v
v8.9.4

OS: Windows 10

I am looking forward for your response!

Thank you in advance,
Martin Lazarov

Description of the enhancement:
Is there any location related to Solutions/Knowledge base?

I've tried something like kbase-sidebar but it doesn't seem to be working.

There are also no events related to Solutions either (e.g. When a Solution is added to the conversation by the agent) but I'm guessing that's because Freshdesk itself does offer them at all.

For which Freshworks product?

• [ X ] Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Describe the solution you'd like

Maintainer's thoughts:

This issue is ideally for pure beginners learning to make PRs and get familiar with open source contributions. Involve yourself to explore how apps on Freshworks developer platform run.

• Find sample code for conditional ticket properties app in the repository and tell us(in comments) if you were able to find it under 30s.
• (Optional) Add summary in JSDoc commenting standards and elaborate parameters if you understand the code.
• Lower case the contents inside the screenshots folder (and Screenshots folder itself). If there's no screenshots just add it if it's a frontend app or else move on to next task.
• Update the README.md file of the same app so that images inside of screenshots folder are displayed on the app README.md file.
• Re organise all the files and folders in following structure

    .
    ├── README.md                   A file for future self and friends to learn about app
    ├── app                         A folder to place files needed for app's frontend components
    │   ├── index.html              The Entry point for the user to use the app
    │   ├── scripts                 JavaScript to handle frontend components business logic
    │   │   └── app.js
    │   ├── styles                  A folder to place all the styles for the app
    │   │   ├── images              A folder for all the images
    │   │   │   └── icon.svg
    │   │   └── styles.css
    │   └── views                   A folder to place all the pages
    │       └── modal.html
    ├── config                      A folder to place configuration pages
    │   └── iparams.json            A JSON oriented way to construct a configuration page
    └── manifest.json               A JSON file holding meta data for app to run on platform

• Install Freshworks CLI
• Locally run the app by getting a trial account for relevant Freshworks' product. We will let you figure out how to do that by exploring the developer documentation. How much time did you take to figure out? 2 min?

Describe
Even though freshdesk apps run smoothly with ES6 javascript code, to ensure nothing breaks freshdesk recommends app's code to be ES5.

Would you be interested in converting ES6 code to ES5 on Ticket top navigation sample app code ?

Noted in which product sample app

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Resources
To ensure running the code after you make changes follow this quick start.

I just did a fresh clone of this repo and tried to run your_first_backend_app using the frsh run command. It fails with the following error:

> frsh run
fs.js:1387
    throw error;
    ^

Error: watch ./backend/lib ENOENT
    at exports._errnoException (util.js:1028:11)
    at FSWatcher.start (fs.js:1385:19)
    at Object.fs.watch (fs.js:1411:11)
    at /usr/local/lib/node_modules/frsh-sdk/lib/watcher.js:31:10
    at Array.forEach (native)
    at Object.watch (/usr/local/lib/node_modules/frsh-sdk/lib/watcher.js:30:11)
    at Object.run (/usr/local/lib/node_modules/frsh-sdk/lib/cli/run.js:51:13)
    at Object.<anonymous> (/usr/local/lib/node_modules/frsh-sdk/index.js:102:30)
    at Module._compile (module.js:571:32)
    at Object.Module._extensions..js (module.js:580:10)

The my_first_app app runs just fine.

I am running on macOS 10.12.4. frsh info report below:

> frsh info
# Project details:
  Platform version: v1.0

# Running on:
  SDK version: v2.3.3
  Node version: v7.6.0

Description of the enhancement:
The Freshservice app called Onclick_alerts is built over an year ago.

Can you Refactor it in a way that it has enough code comments? (Sample commented code)

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Description of the enhancement:
It's a request for a change in the readme file for an existing app.
In the readme file of the Asana serverless OAuth app, there is a list of platform features mentioned which have been used in the app. It would be nice to add links to these features listed with the relevant feature's link from our developer documentation.

For which Freshworks product?

• Freshdesk
• Freshchat
• Freshsales
• Freshservice
• Freshcaller

Resources

• Developer documentation

Welcome to the Freshworks Sample Apps repository! On behalf of my team, I gladly welcome you to contribute to our repo. 👏🏻

Here's a quick checklist before you raise a PR

1. Please make sure you have registered for Hacktoberfest - so that you don't miss out on the goodies.

2. Please follow the contribution guidelines where you'll find resources and steps to make a successful PR.

3. Finally, as it goes without saying, let's make sure we adhere to the code of conduct

Once you have raised the PR, we will reach out to you as soon as we can. Your contributions will be a part of a greater developer community ✨

Describe the sample app use-case :
After a new Hire joins the team, HR might want to reiterate to the new Hire asking for a anonymous feedback. Create an app that will trigger a email with hardcoded anonymous google form link.

More details :

1. freshteam currently supports only serverless apps at the time of this writing.
2. On OnNewHireCreate product event, create a one time schedule in 30 days.
3. This schedule can invoke any free Email API service to send an Hardcoded email with a Google form link init.
4. You may create a Google form before requesting specific feedback manually and just hardcode the link in email template. No need to create it programatically.

• Look out for the app called custom_installation_page_app and navigate to iparams.html in it.
• You will quickly find out it is using the Ajax to make API call. Did you? Yet?
• Figure out what product the app is for by looking at manifest.json
• Search for that Freshworks' product's documentation and search for Request APIor Request Method and understand it's usage. Then re-write the this ajax api call with Request API.
• Install Freshworks CLI
• Locally run the app by getting a trial account for relevant Freshworks' product. We will let you figure out how to do that by exploring the developer documentation. How much time did you take to figure out? 2 min?
• Facing difficulties? Reference to this issue and create a topic in developer community