Freshdesk

Overview

Freshdesk is an omnichannel customer support platform. This Parsons integration with the Freshdesk API provides methods to fetch tickets, contacts, companies, and agents. Results are returned as Parsons Tables.

Note

Authentication

To use the Freshdesk class, you must provide the subdomain of your Freshdesk account and an API Key, which can be found by logging into Freshdesk and following the instructions in the API documentation.

Rate Limits

Rate limits depend on your Freshdesk plan, so be sure to check the API documentation for your rate limits and follow the best practices guide to avoid exceeding them.

Quickstart

To instantiate the Freshdesk class, you can either store your Freshdesk domain and API Key as environmental variables (FRESHDESK_DOMAIN and FRESHDESK_API_KEY, respectively) or pass them in as keyword arguments:

from parsons import Freshdesk

# First approach: Use environmental variables
freshdesk = Freshdesk()

# Second approach: Use keyword arguments
freshdesk = Freshdesk(domain='my_domain', api_key='my_api_key')

You can then call various endpoints:

# Fetch all tickets requested a individual based on their email
freshdesk.get_tickets(requester_email='user@email.com')

# Fetch all contacts in a specific company
freshdesk.get_contacts(company_id='123')

# Fetch a specific agent by their mobile number
freshdesk.get_agents(mobile='7654367287')

API