Freshdesk

Freshdesk logo

Freshdesk

This connector enables AI agents and RAG systems to retrieve context from Freshdesk through Airweave’s unified search layer.

Configuration

Freshdesk source connector.

Syncs tickets, conversations, contacts, companies, and solution articles from Freshdesk.

Authentication

Supported authentication methods:

  • Direct Credentials
  • Auth Provider

Configuration Options

This connector does not have any additional configuration options.

Data Models

The following data models are available for this connector:

Schema for Freshdesk ticket entities.

Reference: https://developers.freshdesk.com/api/#tickets

FieldTypeDescription
ticket_idintUnique identifier of the ticket
subjectstrSubject of the ticket
created_at_valuedatetimeWhen the ticket was created.
updated_at_valuedatetimeWhen the ticket was last updated.
web_url_valueOptional[str]UI URL to open the ticket in Freshdesk.
descriptionOptional[str]HTML content of the ticket
description_textOptional[str]Plain text content of the ticket
statusOptional[int]Status of the ticket (2=Open, 3=Pending, 4=Resolved, 5=Closed)
priorityOptional[int]Priority (1=Low, 2=Medium, 3=High, 4=Urgent)
requester_idOptional[int]ID of the requester
responder_idOptional[int]ID of the assigned agent
company_idOptional[int]ID of the company
group_idOptional[int]ID of the group
typeOptional[str]Ticket type (e.g. Question, Problem)
sourceOptional[int]Channel (1=Email, 2=Portal, 3=Phone, 7=Chat, etc.)
tagsList[str]Tags associated with the ticket
custom_fieldsDict[str, Any]Custom field values

Schema for Freshdesk conversation entities (replies and notes on a ticket).

Reference: https://developers.freshdesk.com/api/#list-all-conversations-of-a-ticket

FieldTypeDescription
conversation_idintUnique identifier of the conversation
ticket_idintID of the ticket this conversation belongs to
ticket_subjectstrSubject of the parent ticket
bodyOptional[str]HTML content of the conversation
body_textstrPlain text content of the conversation
created_at_valuedatetimeWhen the conversation was created.
updated_at_valueOptional[datetime]When the conversation was last updated.
user_idOptional[int]ID of the user who created the conversation
incomingboolTrue if from outside (e.g. customer reply)
privateboolTrue if the note is private
web_url_valueOptional[str]URL to the ticket (conversations don’t have direct URLs).

Schema for Freshdesk contact entities.

Reference: https://developers.freshdesk.com/api/#contacts

FieldTypeDescription
contact_idintUnique identifier of the contact
namestrName of the contact
emailOptional[str]Primary email address
created_at_valuedatetimeWhen the contact was created.
updated_at_valuedatetimeWhen the contact was last updated.
web_url_valueOptional[str]URL to the contact in Freshdesk.
company_idOptional[int]ID of the primary company
job_titleOptional[str]Job title
phoneOptional[str]Phone number
mobileOptional[str]Mobile number
descriptionOptional[str]Description of the contact
tagsList[str]Tags associated with the contact
custom_fieldsDict[str, Any]Custom field values

Schema for Freshdesk company entities.

Reference: https://developers.freshdesk.com/api/#companies

FieldTypeDescription
company_idintUnique identifier of the company
namestrName of the company
created_at_valuedatetimeWhen the company was created.
updated_at_valuedatetimeWhen the company was last updated.
web_url_valueOptional[str]URL to the company in Freshdesk.
descriptionOptional[str]Description of the company
noteOptional[str]Notes about the company
domainsList[str]Domains associated with the company
custom_fieldsDict[str, Any]Custom field values
industryOptional[str]Industry

Schema for Freshdesk solution/knowledge base article entities.

Reference: https://developers.freshdesk.com/api/#articles

FieldTypeDescription
article_idintUnique identifier of the article
titlestrTitle of the article
created_at_valuedatetimeWhen the article was created.
updated_at_valuedatetimeWhen the article was last updated.
web_url_valueOptional[str]URL to the article in Freshdesk.
descriptionOptional[str]HTML content of the article
description_textOptional[str]Plain text content of the article
statusOptional[int]Status (1=draft, 2=published)
folder_idOptional[int]ID of the folder
category_idOptional[int]ID of the category
folder_nameOptional[str]Name of the folder
category_nameOptional[str]Name of the category
tagsList[str]Tags associated with the article