API Key

The domain of your Freshdesk account. For example, if your Freshdesk URL is https://mycompany.freshdesk.com, then your domain is mycompany.


Freshdesk Domain

Freshdesk

Account

Type of Agent (1 -> Support Agent, 2 -> Field Agent, 3 -> Collaborator). By default, support agent is created

Support Agent

Field Agent

Collaborator

Language of the Agent. Default language is "en"

Set to true if this is an occasional agent (true => occasional, false => full-time)

Role IDs associated with the agent. At least one role should be associated with the agent. Current logged in agent can't update his/her role_ids (Role IDs should be corresponding to the type of agents. For example: Ticket collaborator for collaborator agent, Agent or admin for support agent)

Global Access

Group Access

Restricted Access

Time zone of the Agent. Default value is time zone of the domain

Agents

Classification based on how much value the company brings to your business

Key value pairs containing the names and values of custom fields. Only dates in the format YYYY-MM-DD are accepted as input for custom date fields. Read more here

Domains of the company. Email addresses of contacts that contain this domain will be associated with that company automatically.

The strength of your relationship with the company

This attribute for companies can only be set if Custom Objects feature is enabled. The value can either be in the form of the display_id (record id) or primary_field_value (user defined record value). The default value is display_id.

Date when your contract or relationship with the company is due for renewal

Companies

Avatar image of the contact. The maximum file size is 5MB and the supported file types are .jpg, .jpeg, .jpe, and .png

ID of the primary company to which this contact belongs

Primary email address of the contact. If you want to associate additional email(s) with this contact, use the other_emails attribute.

Language of the contact. Default language is "en". This attribute can only be set if the Multiple Language feature is enabled (Garden plan and above)

This attribute for contacts can only be set if the Custom Objects feature is enabled. The value can either be in the form of the display_id (record id) or primary_field_value (user defined record value). The default value is display_id.

Additional companies associated with the contact. This attribute can only be set if the Multiple Companies feature is enabled (Estate plan and above)

Additional emails associated with the contact

Time zone of the contact. Default value is the time zone of the domain. This attribute can only be set if the Multiple Time Zone feature is enabled (Garden plan and above)

Set to true if the contact can see all the tickets that are associated with the company to which he belong

Contacts

Products

Roles

Ticket attachments. The total size of these attachments cannot exceed 20MB.

Email address added in the 'cc' field of the incoming ticket email

Company ID of the requester. This attribute can only be set if the Multiple Companies feature is enabled (Estate plan and above)

Key value pairs containing the names and values of custom fields. Read more here

Timestamp that denotes when the ticket is due to be resolved

Email address of the requester. If no contact exists with this email address in Freshdesk, it will be added as a new contact.

Facebook ID of the requester. A contact should exist with this facebook_id in Freshdesk.

Timestamp that denotes when the first response is due

ID of the internal agent which the ticket should be assigned with

ID of the internal group to which the ticket should be assigned with

This attribute for tickets can only be set if Custom Objects is enabled and a lookup field has been added under ticket fields. The value can either be in the form of the display_id (record id) or primary_field_value (user defined record value). The default value is display_id.

ID of the parent ticket that this ticket should be linked to. When passing this field, the current ticket actioned upon will be converted to a child ticket.

Phone number of the requester. If no contact exists with this phone number in Freshdesk, it will be added as a new contact. If the phone number is set and the email address is not, then the name attribute is mandatory.

Priority of the ticket. The default value is 1.

Medium

High

Urgent

ID of the product to which the ticket is associated. It will be ignored if the email_config_id attribute is set in the request.

User ID of the requester. For existing contacts, the requester_id can be passed instead of the requester's email.

ID of the agent to whom the ticket has been assigned

The channel through which the ticket was created. The default value is 2.

Email

Portal

Phone

Chat

Feedback Widget

Outbound Email

Status of the ticket. The default Value is 2.

Open

Pending

Resolved

Closed

Subject of the ticket. The default Value is null.

Twitter handle of the requester. If no contact exists with this handle in Freshdesk, it will be added as a new contact.

Helps categorize the ticket according to the different kinds of issues your support team deals with. The default Value is null.

External ID of the requester. If no contact exists with this external ID in Freshdesk, they will be added as a new contact.

Tickets

The ID of the agent to whom this time-entry is associated.

Set to true if the time entry is billable.

Time at which this time-entry was added/created.

The time at which the time-entry is added or the time of the last invoked 'start-timer' action using a toggle.

The ID of the ticket to which this time entry is associated.

Set to 'true' if the timer is currently running.

Time Entry

Retrieve details of a specific role by its ID.

View a Role

Retrieve a list of all roles available in the support portal.

List all Roles

View a skill

Delete a skill

Update a skill

List all skills

Create a skill

Allows an agent to create a time entry for a ticket.

Create a Time Entry

Retrieve a list of time entries with optional filters.

List All Time Entries

Update a Time Entry

Allows an agent to delete a time entry. Deleted time entries cannot be restored.

Delete a Time Entry

Toggle the running state of the timer for a time entry.

Start/Stop Timer

View an Agent

Update an Agent

Delete an Agent

List all Agents

Create an Agent

Get Currently Authenticated Agent

Create Multiple Agents

Search Agents

Create a contact

List all contacts

View a contact

Update a contact

Soft delete a contact

Permanently delete a contact

Create a Company

List all Companies

View a Company

Update a Company

Delete a Company

Search Companies

Filter Companies

Create a new group with various settings including automatic agent assignment.

Create a Group

Retrieve details of a specific group by ID.

View a Group

Update settings of a specific group by ID.

Update a Group

Delete a Group

Retrieve all agents that are part of a specific group by ID.

List All Agents in a Group

Add or remove agents to/from a specific group by ID.

Add or Remove Agents in a Group

Salesforce

HubSpot

Microsoft Dynamics 365

Zoho CRM

Pipedrive

Freshsales

Keap

SugarCRM

Outreach

Xero

ActiveCampaign

Capsule CRM

Salesloft

Agile CRM

SalesForce Pardot

SharpSpring

Teamleader

Insightly

Zendesk

Sage Accounting

Attio

Copper

Intercom

Zoho Books

Front

Close

Breezy HR

Affinity

Exact Online

Mautic

# Realtime Full two-way Sync of Companies

This scenario enables your application to fully sync Companies between your app and any external application in both directions. It handles the initial import/export of Companies and then sends events when a Company is created, updated, or deleted on any side, as close to real-time as possible.

Company fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Companies in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Companies to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Companies

Bi-directional realtime sync of Companies with records deduplication

Mailchimp

NetSuite

AWeber

Apollo.io

GoHighLevel

Ontraport

Jobnimbus

# Continuous Import of Contacts to Your App

This scenario enables your application to continuously sync Contacts from any external application to your app's API. It handles the initial import of Contacts and keeps them synchronized when a Contact is created, updated, or deleted in the external application.

When receiving Contacts data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Contacts to my App

Import Contacts and receive created/updated or deleted events

Microsoft Sharepoint

Monday

Slack

Jira

Asana

Github

Notion

Clickup

Microsoft Teams

Greenhouse Harvest

Calendly

BambooHR

Basecamp

Okta

Deel

Lever

Google Workspace

Microsoft Entra ID

# Continuous Import of Users to Your App

This scenario enables your application to continuously sync Users from any external application to your app's API. It handles the initial import of Users and keeps them synchronized when a User is created, updated, or deleted in the external application.

When receiving Users data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Users to my App

Import Users and receive created/updated or deleted events

Quickbooks

Shopify

Stripe

Woocommerce

Chargebee

BigCommerce

PayPal

# Continuous Import of Products to Your App

This scenario enables your application to continuously sync Products from any external application to your app's API. It handles the initial import of Products and keeps them synchronized when a Product is created, updated, or deleted in the external application.

When receiving Products data from the external application, the data is transformed into a format supported by your app's API. Additionally, if needed, your customers can customize the data mapping based on their specific external application setup.

## How It Works

1. **Initial Import**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page.
   - Integration.app transforms the output into a consistent format compatible with your API, allowing you to save the data efficiently.

2. **Continuous Sync**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.

Continuously Import Products to my App

Import Products and receive created/updated or deleted events

	Companies automatically maps to	Contacts automatically maps to	Users automatically maps to	Tasks automatically maps to	Products automatically maps to
Salesforce	Accounts	Contacts	Users	Tasks	Products
Zoho CRM	Accounts	Contacts	Users	Tasks	Products
Zoho Books	Contacts	Contact Persons	Users	Tasks	Items
Keap	Companies	Contacts	Users	Tasks	—
Microsoft Dynamics 365	Accounts	Contacts	Systemusers	Tasks	—
Capsule CRM	Organisations	People	Users	Tasks	—
Salesloft	Accounts	People	Users	Tasks	—
Agile CRM	Companies	Contacts	Users	Tasks	—
Xero	Organisation	Contacts	Users	—	Items
Freshsales	Accounts	Contacts	Owners	Tasks	—

Freshdesk API Integration Profile

Data Collections

Operations

Integration Scenarios

Two-way realtime sync of Companies

Continuously Import Contacts to my App

Continuously Import Users to my App

Continuously Import Products to my App

Delete Company

Continuously Import Tasks to my App

Use the same code to integrate with Freshdesk and 100+ other applications

Companies

Contacts

Users

Tasks

Products

Supercharge your product integrations today