This is a Singer tap that produces JSON-formatted data following the Singer spec.
This tap:
Install
> pip install tap-freshdesk
Get your Freshdesk API Key
Login to your Freshdesk account, navigate to your profile settings page, and save "Your API Token", you'll need it for the next step.
Create the config file
Create a JSON file called config.json
containing the api token you just found and
the subdomain to your Freshdesk account. The subdomain will take the format
subdomain.freshdesk.com
.
{
"api_key": "your-api-token",
"domain": "subdomain",
"start_date": "2017-01-17T20:32:05Z"
}
[Optional] Create the initial state file
You can provide JSON file that contains a date for the API endpoints to force the application to only fetch data newer than those dates. If you omit the file it will fetch all Freshdesk data
{"tickets": "2017-01-17T20:32:05Z",
"agents": "2017-01-17T20:32:05Z",
"roles": "2017-01-17T20:32:05Z",
"groups": "2017-01-17T20:32:05Z",
"companies": "2017-01-17T20:32:05Z",
"contacts": "2017-01-17T20:32:05Z"}
Run the application
tap-freshdesk
can be run with:
tap-freshdesk --config config.json [--state state.json]
Copyright © 2017 Stitch