Get started
This project is a Node.js SDK used to interact with Freshworks public REST APIs. Refer to below sections to get started with.
⚠️ WARNING: While accessing API references and Object references, kindly open the links in new tab to avoid unexpected site behaviour!
Install
Installing in a Node.js project
Installing in a Node.js project needs you to install the @freshworks/api-sdk
package:
npm install --save @freshworks/api-sdk
Installing in a Freshworks app
To use this library in a Freshworks app, add the following to the "dependencies"
object in manifest.json
:
{
// ...
"dependencies": {
"@freshworks/api-sdk": "0.3.0"
}
}
The Freshworks CLI (fdk
) will fetch the dependency next time you run fdk run
.
Sample code
Next step
- See how to use the API SDK for Freshteam.
- See how to use the API SDK for Freshservice.