Config Export & Audit documentation

Requirements

• A Freshdesk account on a plan that allows Marketplace applications.
• The API key of an administrator. Freshdesk shows automation rules and SLA policies only to administrators.

Configuration

The application asks for your Freshdesk subdomain (acme for acme.freshdesk.com) and an administrator's API key. Both are checked together against your account before installation completes; a key that cannot read automation rules is refused. The key is stored as a Freshworks secure installation parameter: the platform attaches it to outbound request headers and it is never exposed to the browser.

Using it

• Read configuration: reads every area in one pass and shows how many items each has. Areas your plan or role cannot read are named and skipped.
• Excel: one sheet per area, plus Summary and Audit sheets, with a frozen header row and filters.
• PDF report: opens in a new tab with your browser's print dialog; choose Save as PDF. If the tab is blocked, an HTML file is downloaded instead.
• Snapshot (.json): keep it. Next time, choose it under What changed and click Compare. A snapshot from a different account is flagged.
• Read configuration again in the same session to see what changed since your previous read.

Limits you should know

• Freshworks limits an application to 50 requests per minute per installation, and those requests count against your account's API limit. A full read takes about 20 requests on a typical account.
• Excel cells hold at most 32,767 characters; longer text is cut there and marked as truncated.
• Unreferenced-field notes check automation rules, scenarios and SLA policies only; ticket forms and reports are not checked.