Overview
Add Freshdesk to any ModuleX agent or workflow. Customer support helpdesk platform for managing tickets, contacts, agents, and knowledge base articles via the Freshdesk REST API ({domain}.freshdesk.com/api/v2).
Authentication
API Key Authentication
Authenticate using your Freshdesk API key and subdomainStep 1
Step 2
Step 3
Step 4
Required Credentials
Available Actions
create_ticket — Create a new support ticket in Freshdesk
create_ticket — Create a new support ticket in Freshdesk
Parameters
1)2)Response
get_ticket — Retrieve a specific ticket by its ID
get_ticket — Retrieve a specific ticket by its ID
update_ticket — Update an existing ticket's properties
update_ticket — Update an existing ticket's properties
Parameters
Response
list_all_tickets — List tickets in Freshdesk with optional filtering
list_all_tickets — List tickets in Freshdesk with optional filtering
close_ticket — Close a ticket by setting its status to Closed (5)
close_ticket — Close a ticket by setting its status to Closed (5)
add_note_to_ticket — Add a private or public note to a ticket
add_note_to_ticket — Add a private or public note to a ticket
set_ticket_priority — Set the priority of a ticket
set_ticket_priority — Set the priority of a ticket
set_ticket_status — Set the status of a ticket
set_ticket_status — Set the status of a ticket
assign_ticket_to_agent — Assign a ticket to a specific agent
assign_ticket_to_agent — Assign a ticket to a specific agent
assign_ticket_to_group — Assign a ticket to a specific group
assign_ticket_to_group — Assign a ticket to a specific group
create_contact — Create a new contact in Freshdesk
create_contact — Create a new contact in Freshdesk
get_contact — Retrieve a contact by their ID
get_contact — Retrieve a contact by their ID
update_contact — Update an existing contact's properties
update_contact — Update an existing contact's properties
create_company — Create a new company in Freshdesk
create_company — Create a new company in Freshdesk
create_agent — Create a new agent in Freshdesk
create_agent — Create a new agent in Freshdesk
update_agent — Update an existing agent's properties
update_agent — Update an existing agent's properties
get_agent — Retrieve a single agent by their ID
get_agent — Retrieve a single agent by their ID
list_agents — List all agents in Freshdesk with optional filtering
list_agents — List all agents in Freshdesk with optional filtering
create_reply — Create a reply to a ticket
create_reply — Create a reply to a ticket
forward_ticket — Forward a ticket to an external email address
forward_ticket — Forward a ticket to an external email address
create_thread — Create a collaboration thread on a ticket
create_thread — Create a collaboration thread on a ticket
create_message_for_thread — Create a message in a collaboration thread
create_message_for_thread — Create a message in a collaboration thread
list_ticket_conversations — List all conversations (notes, replies) for a ticket
list_ticket_conversations — List all conversations (notes, replies) for a ticket
list_ticket_fields — List all ticket fields configured in Freshdesk
list_ticket_fields — List all ticket fields configured in Freshdesk
create_ticket_field — Create a new custom ticket field
create_ticket_field — Create a new custom ticket field
update_ticket_field — Update a custom ticket field
update_ticket_field — Update a custom ticket field
create_solution_article — Create a knowledge base article in a folder
create_solution_article — Create a knowledge base article in a folder
get_solution_article — Retrieve a knowledge base article by its ID
get_solution_article — Retrieve a knowledge base article by its ID
update_solution_article — Update a knowledge base article
update_solution_article — Update a knowledge base article
delete_solution_article — Delete a knowledge base article
delete_solution_article — Delete a knowledge base article
search_solution_article — Search knowledge base articles by keyword
search_solution_article — Search knowledge base articles by keyword
list_solution_categories — List all knowledge base solution categories
list_solution_categories — List all knowledge base solution categories
Response
list_category_folders — List all folders within a solution category
list_category_folders — List all folders within a solution category
list_folder_articles — List all articles within a solution folder
list_folder_articles — List all articles within a solution folder
list_all_folders — List all canned response folders
list_all_folders — List all canned response folders
list_folder_canned_responses — List all canned responses in a specific folder
list_folder_canned_responses — List all canned responses in a specific folder
get_canned_response — Retrieve a specific canned response by ID
get_canned_response — Retrieve a specific canned response by ID
get_folder_canned_responses — Get detailed canned responses from a folder
get_folder_canned_responses — Get detailed canned responses from a folder
list_companies — List all companies in Freshdesk
list_companies — List all companies in Freshdesk
Response
list_email_configs — List all email configurations
list_email_configs — List all email configurations
Response
list_roles — List all agent roles
list_roles — List all agent roles
Response
Limits & Quotas
- Rate limits: Freshdesk applies per-plan rate limits. Free plans: 50 calls/min. Growth and above: 200-400+ calls/min depending on plan.
- Pagination: List endpoints return up to 100 results per page by default.
- Error model: non-2xx responses are caught and returned as
success=False+errorrather than raising.