Freshdesk Tables
The Freshdesk integration includes the following permissions and tables
Tables
FreshdeskAgents
| Name | Type | Description |
|---|---|---|
| ID | long | User ID of the agent. |
| Available | boolean | If the agent is in a group that has enabled Automatic Ticket Assignment, this attribute will be set to true if the agent is accepting new tickets. |
| Occasional | boolean | Set to true if this is an occasional agent. true -> occasional, false -> full-time |
| TicketScope | integer | Ticket permission of the agent: 1 -> Global Access, 2 -> Group Access, 3 -> Restricted Access |
| CreatedAt | datetime | Agent creation timestamp. |
| UpdatedAt | datetime | Agent updated timestamp. |
| AvailableSince | datetime | Timestamp that denotes when the agent became available/unavailable (depending on the value of the available attribute). |
| Type | string | Type of Agent: support_agent -> Support Agent, field_agent -> Field Agent, collaborator -> Collaborator |
| Active | boolean | Set to true if the agent is verified. |
| Name | string | Name of the Agent. |
| string | Email address of the Agent. | |
| Langauge | string | Language of the Agent. Default language is en. |
| LastLoginAt | datetime | Timestamp of the agent's last successful login. |
| Mobile | string | Mobile number of the agent. |
| Phone | string | Telephone number of the agent. |
| TimeZone | string | Time zone of the Agent. Default value is time zone of the domain. |
| ContactInfoCreatedAt | datetime | Timestamp from when the contact was first created. |
| ContactInfoUpdatedAt | datetime | Timestamp of the last update to the contact. |
FreshdeskCompanies
| Name | Type | Description |
|---|---|---|
| ID | long | Unique ID of the company. |
| Name | string | Name of the company. |
| Description | string | Description of the company. |
| Domains | string | Domains of the company. Email addresses of contacts that contain this domain will be associated with that company automatically. |
| Note | string | Any specific note about the company. |
| CreatedAt | datetime | Company creation timestamp. |
| UpdatedAt | datetime | Company updated timestamp. |
| HealthScore | string | The strength of your relationship with the company. |
| AccountTier | string | Classification based on how much value the company brings to your business. |
| RenewalDate | datetime | Date when your contract or relationship with the company is due for renewal. |
| Industry | string | The industry the company serves in. |
| OrgCompanyID | string | Freshdesk Organizational identifier. |
FreshdeskContacts
| Name | Type | Description |
|---|---|---|
| ID | long | ID of the contact. |
| Active | boolean | Set to true if the contact has been verified. |
| Address | string | Address of the contact. |
| CompanyID | long | ID of the primary company to which this contact belongs. |
| Description | string | A short description of the contact. |
| string | Primary email address of the contact. If you want to associate additional email(s) with this contact, use the other_emails attribute. | |
| JobTitle | string | Job title of the contact. |
| Language | string | Language of the contact. |
| Mobile | string | Mobile number of the contact. |
| Phone | string | Telephone number of the contact. |
| TimeZone | string | Time zone in which the contact resides. |
| TwitterID | string | Twitter handle of the contact. |
| FacebookID | string | Facebook handle of the contact. |
| CSATRating | string | Customer satisfaction rating associated with the contact. |
| PreferredSource | string | Preferred communication source. |
| UniqueExternalID | string | External ID of the contact. |
| FirstName | string | First name of the contact. |
| LastName | string | Last name of the contact. |
| VisitorID | string | Freshdesk visitor identifier. |
| OrgContactID | long | Freshdesk organizational identifier. |
| CreatedAt | datetime | Contact creation timestamp. |
| UpdatedAt | datetime | Contact updated timestamp. |
| Deleted | boolean | Set to true if the contact is deleted, false otherwise. |
FreshdeskGroups
| Name | Type | Description |
|---|---|---|
| ID | long | Unique ID of the group. |
| Name | string | Name of the group. |
| Description | string | Description of the group. |
| EscalateTo | long | The ID of the user to whom an escalation email is sent if a ticket is unassigned. |
| UnassignedFor | string | The time after which an escalation email is sent if a ticket remains unassigned. The accepted values are 30m for 30 minutes, 1h for 1 hour, 2h for 2 hours, 4h for 4 hours, 8h for 8 hours, 12h for 12 hours, 1d for 1 day, 2d for 2 days, and 3d for 3 days |
| BuinessCalendarID | long | Unique ID of the business calendar associated with the group. |
| Type | string | Group type from the list : support_agent_group, field_agent_group |
| CreatedAt | datetime | Group creation timestamp. |
| UpdatedAt | datetime | Group updated timestamp. |
| AutomaticAgentAssignment | boolean | Whether automatic agent assignment is enabled. |
| AllowAgentsToChangeAvailability | boolean | Set to true if agents are allowed to change availability. |
| AgentAvailabilityStatus | boolean | Availability of agents in this group. |
FreshdeskProducts
| Name | Type | Description |
|---|---|---|
| ID | long | Unique ID of the product. |
| Name | string | Name of the product. |
| Description | string | Description of the product. |
| PrimaryEmail | string | Primary email associated with the product. |
| CreatedAt | datetime | Product creation timestamp. |
| UpdatedAt | datetime | Product updated timestamp. |
| Default | boolean | Set to true if this is the default product. |
FreshdeskRoles
| Name | Type | Description |
|---|---|---|
| ID | long | Unique ID of the Role. |
| Name | string | Name of the Role. |
| Description | string | Description of the Role. |
| Default | boolean | Set to true if this is the default role. |
| CreatedAt | datetime | Role creation timestamp. |
| UpdatedAt | datetime | Role updated timestamp. |
| AgentType | string | Type of Agent: 1 -> Support Agent, 2 -> Field Agent, 3 -> Collaborator. By default, support agent is created |
FreshdeskTickets
| Name | Type | Description |
|---|---|---|
| ID | integer | Unique ID of the ticket. |
| FREscalated | boolean | Set to true if the ticket has been escalated as the result of first response time being breached. |
| Spam | boolean | Set to true if the ticket has been marked as spam. |
| EmailConfigID | long | ID of email config which is used for this ticket. (i.e., [[email protected]](mailto:[email protected])/[email protected]) |
| GroupID | long | ID of the group to which the ticket has been assigned. |
| Priority | integer | Priority of the ticket. |
| RequesterID | long | User ID of the requester. For existing contacts, the requester_id can be passed instead of the requester's email. |
| ResponderID | long | ID of the agent to whom the ticket has been assigned. |
| Source | integer | The channel through which the ticket was created. |
| CompanyID | long | ID of the company to which this ticket belongs. |
| Status | integer | Status of the ticket. |
| Subject | string | Subject of the ticket. |
| AssociationType | string | Type of ticket: 1 -> Parent, 2 -> Child, 3 -> Tracker, 4 -> Related |
| SupportEmail | string | Email address from which the ticket is forwarded. For notes, this value will be null. |
| ProductID | long | ID of the product to which the ticket is associated. |
| Type | string | Helps categorize the ticket according to the different kinds of issues your support team deals with. |
| DueBy | datetime | Timestamp that denotes when the ticket is due to be resolved. |
| FRDueBy | datetime | Timestamp that denotes when the first response is due. |
| IsEscalated | boolean | Set to true if the ticket has been escalated for any reason. |
| CreatedAt | datetime | Ticket creation timestamp. |
| UpdatedAt | datetime | Ticket updated timestamp. |
| AssociatedTicketsCount | integer | Number of tickets associated with the ticket. |
| InternalAgentID | long | ID of the internal agent which the ticket should be assigned with. |
| InternalGroupID | long | ID of the internal group to which the ticket should be assigned with. |
| FRDueBy | datetime | Timestamp that denotes when the first response is due. |
| FREscalated | boolean | Set to true if the ticket has been escalated as the result of first response time being breached. |
| ToEmails | string | Email addresses to which the ticket was originally sent. |
| Tags | string | Tags that have been associated with the ticket. |
| CCEmails | string | Email address added in the 'cc' field of the incoming ticket email. |
| FWDEmails | string | Email address(e)s added while forwarding a ticket. |
| ReplyCCEmails | string | Email address added while replying to a ticket. |
| TicketBCCEmails | string | Email address added in the 'bcc' field of the outgoing forward email. |
FreshdeskAgents_FreshdeskRoles
| Name | Type | Description |
|---|---|---|
| AgentID | long | ID of the agent. |
| RoleID | long | ID of the role. |
FreshdeskAgents_FreshdeskGroups
| Name | Type | Description |
|---|---|---|
| AgentID | long | ID of the agent. |
| RoleID | long | ID of the role. |
Updated over 1 year ago
Learn more...
Did this page help you?