Overview
Configuration is provided for establishing connections with Freshdesk service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this guide, we’ll demonstrate how to read data from the Freshdesk service resource using the COZYROC REST Source component.”
Step 1. Select an existing Data Flow Task or create a new one.
Step 2. Open the SSIS Toolbox and drag the COZYROC REST Source component into your Data Flow.
Step 3. Double-click the REST Source component and choose your Freshdesk connection from the first drop-down menu.
Next, select the desired Freshdesk resource from the second drop-down menu.
If required, specify any parameters in the grid below.
Step 4. Click on the Columns tab and select Freshdesk resource columns you want to read.
Step 5. Click Preview to verify that all required resource columns are included.
Congratulations! You have successfully learned how to read data from the Freshdesk service.
In this guide, we’ll demonstrate how to write data to the Freshdesk service resource using the COZYROC REST Destination component.
Step 1. Select an existing Data Flow Task or create a new one.
Step 2. Open the SSIS Toolbox and drag the COZYROC REST Destination component into your Data Flow.
Step 3. Double-click the REST Destination component and select your Freshdesk connection from the first drop-down menu.
Then, choose the desired resource and resource action you want to work with.
Step 4. Click the Mapping tab and map the input columns for the process you are configuring.
To provide input for other resource composite objects, adjust the input above and map the corresponding columns.
Congratulations! You have successfully learned how to write data to the Freshdesk resource.
Configuration
Base URL address: https://[domain]/api/v2.
- Basic
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- APIKey:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Basic {{=Base64.encode(connection.user.APIKey + ':' + 'X')}}
Documentation: https://developer.freshdesk.com/api/#authentication.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tickets.The following request parameters will be automatically processed:
-
include:
{{=Freshdesk.getTicketExpandFields(parameters)}}
Documentation: https://developer.freshdesk.com/api/#list_all_tickets.
-
include:
- [Read Single] action
-
Endpoint URL address:
/tickets/{{=parameters.id}}.The following request parameters will be automatically processed:
-
include:
{{=Freshdesk.getTicketExpandFields(parameters)}}
Documentation: https://developer.freshdesk.com/api/#view_a_ticket.
-
include:
- [Read Filter] action
-
Endpoint URL address:
/search/tickets.
The result is extracted from:{{=response.results}}.
The result is paginated.The action has the following user-defined parameters:
- query: Required. Defines the filter query to execute. For example: "priority:3".
The following request parameters will be automatically processed:
-
include:
{{=Freshdesk.getTicketExpandFields(parameters)}} -
per_page:
{{=undefined}}
Documentation: https://developer.freshdesk.com/api/#filter_tickets.
- [Read Archived] action
-
Endpoint URL address:
/tickets/archived/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Specify the archived ticket identifier.
The following request parameters will be automatically processed:
-
include:
{{=Freshdesk.getTicketExpandFields(parameters)}} -
per_page:
{{=undefined}}
Documentation: https://developer.freshdesk.com/api/#archive_tickets.
- [Create] action
-
Endpoint URL address:
/tickets.Documentation: https://developer.freshdesk.com/api/#create_ticket.
- [Update] action
-
Endpoint URL address:
/tickets/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_ticket.
- [Delete] action
-
Endpoint URL address:
/tickets/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_a_ticket.
- id
A key field. Template: Id.
- cc_emails
Template: LongText. A composite field.
- fwd_emails
Template: LongText. A composite field.
- reply_cc_emails
Template: LongText. A composite field.
- ticket_cc_emails
Template: LongText. A composite field.
- ticket_bcc_emails
Template: LongText. A composite field.
- email_config_id
Template: Id.
- fr_escalated
Data type: DT_BOOL
- group_id
Template: Id.
- priority
Data type: DT_I4
- requester_id
Template: Id.
- responder_id
Template: Id.
- source
Data type: DT_I4
- spam
Data type: DT_BOOL
- archived
Data type: DT_BOOL
- status
Data type: DT_I4
- sentiment_score
Data type: DT_R8
- initial_sentiment_score
Data type: DT_R8
- subject
Template: ShortText.
- support_email
Template: ShortText.
Template: ShortText.
- type
Template: ShortText.
- to_emails
Template: ShortText.
- product_id
Template: Id.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- due_by
Template: DateTime.
- nr_due_by
Template: DateTime.
- fr_due_by
Template: DateTime.
- is_escalated
Data type: DT_BOOL
- nr_escalated
Data type: DT_BOOL
- association_type
Template: ShortText.
- description_text
Template: LongText.
- description
Template: LongText.
- source_additional_info
Template: LongText.
- structured_description
Template: LongText.
- tags
Template: LongText. A composite field.
- attachments
Field components:
- An array.
-
Uses template:
Attachment.
- requester
Field components:
-
Uses template:
Id. - Contains the following components: id, name, email, mobile, phone.
-
Uses template:
- stats
Field components:
-
Uses template:
DateTime. - Contains the following components: agent_responded_at, requester_responded_at, first_responded_at, status_updated_at, reopened_at, resolved_at, closed_at, pending_since.
-
Uses template:
- company
Field components:
-
Uses template:
Id. - Contains the following components: id, name.
-
Uses template:
- sla_policy
Field components:
-
Uses template:
Id. - Contains the following components: id, name, description, active, sla_target, applicable_to, is_default, position, created_at, updated_at, escalation.
-
Uses template:
- conversations
Field components:
- An array.
-
Uses template:
TicketConversation.
- EventLevel
Field components:
-
Uses template:
ShortText. - Contains the following components: field_name, value.
-
Uses template:
- associated
The value is gathered from
/tickets/{{=item.id}}/associated_ticketsaddress. The gathered value is processed with{{=response.tickets}}expression. Field components:- An array.
-
Uses template:
Associated.
- prime_associated
Template: Associated. The value is gathered from
/tickets/{{=item.id}}/prime_associationaddress.- watcher_ids
Template: LongText. A composite field. The value is gathered from
/tickets/{{=item.id}}/watchersaddress. The gathered value is processed with{{=response.watcher_ids}}expression.- user_accesses
Template: LongText. A composite field. The value is gathered from
/tickets/{{=item.id}}/accessesaddress. The gathered value is processed with{{=response.user_ids}}expression.- summary
Template: TicketSummary. The value is gathered from
/tickets/{{=item.id}}/summaryaddress.- satisfaction_ratings
The value is gathered from
/tickets/{{=item.id}}/satisfaction_ratingsaddress. Field components:- An array.
-
Uses template:
TicketRating.
- time_entries
The gathered value is processed with
{{=connection.resourceManager['Ticket | Time Entry'].getData({ parameters: ['id=' + item.id] })}}expression. Field components:- An array.
-
Uses template:
TicketEntry.
- action
Field components:
-
Uses template:
ActionT. - Contains the following components: restore, merge.
-
Uses template:
- [External]
-
The external fields URL address:
/admin/ticket_fields. The external fields list is extracted from:{{=Freshdesk.getCustomFields(response)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tickets/{{=parameters.id}}/time_entries.The action has the following user-defined parameters:
- id: Required. Specify the ticket identifier.
The following request parameters will be automatically processed:
-
per_page:
{{=undefined}}
Documentation: https://developer.freshdesk.com/api/#list_all_ticket_timeentries.
The resource includes the fields from the TicketEntry template.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/tickets/{{=parameters.id}}/summary.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the ticket identifier.
- [Update] action
-
Endpoint URL address:
/tickets/{{=item.ticket_id}}/summary.
- [Delete] action
-
Endpoint URL address:
/tickets/{{=item.ticket_id}}/summary.
The resource includes the fields from the TicketSummary template.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/tickets/{{=parameters.id}}/accesses.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the ticket identifier.
- [Create] action
-
Endpoint URL address:
/tickets/{{=item.ticket_id}}/accesses.
- [Update] action
-
Endpoint URL address:
/tickets/{{=item.ticket_id}}/accesses.The following request parameters will be automatically processed:
-
application/json:
{{={ user_ids: item.user_id } }}
-
application/json:
- ticket_id
A key field. Template: Id.
- user_ids
Template: LongText. A composite field.
- user_id
Field components:
- An array.
- Contains the following components: id, deleted.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/tickets/{{=parameters.id}}/watchers.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the ticket identifier.
- [Create] action
-
Endpoint URL address:
/tickets/{{=item.ticket_id}}/watchers.
- [Delete] action
-
Endpoint URL address:
/tickets/{{=item.ticket_id}}/watchers.
- ticket_id
A key field. Template: Id.
- watcher_ids
Template: LongText. A composite field.
- user_id
Template: Id.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/tickets/archived/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the ticket identifier.
- [Delete] action
-
Endpoint URL address:
/tickets/archived/{{=item.id}}.
- id
A key field. Data type: Id
- cc_emails
Template: LongText. A composite field.
- fwd_emails
Template: LongText. A composite field.
- reply_cc_emails
Template: LongText. A composite field.
- ticket_cc_emails
Template: LongText. A composite field.
- ticket_bcc_emails
Template: LongText. A composite field.
- email_config_id
Template: Id.
- fr_escalated
Data type: DT_BOOL
- group_id
Template: Id.
- priority
Data type: DT_I4
- requester_id
Template: Id.
- responder_id
Template: Id.
- source
Data type: DT_I4
- spam
Data type: DT_BOOL
- archived
Data type: DT_BOOL
- status
Data type: DT_I4
- sentiment_score
Data type: DT_R8
- initial_sentiment_score
Data type: DT_R8
- subject
Template: ShortText.
- support_email
Template: ShortText.
Template: ShortText.
- type
Template: ShortText.
- to_emails
Template: ShortText.
- product_id
Template: Id.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- due_by
Template: DateTime.
- nr_due_by
Template: DateTime.
- fr_due_by
Template: DateTime.
- is_escalated
Data type: DT_BOOL
- nr_escalated
Data type: DT_BOOL
- association_type
Template: ShortText.
- description_text
Template: LongText.
- description
Template: LongText.
- source_additional_info
Template: LongText.
- structured_description
Template: LongText.
- tags
Template: LongText. A composite field.
- attachments
Field components:
- An array.
-
Uses template:
Attachment.
- conversations
The value is gathered from
/tickets/archived{{=item.id}}/conversationsaddress. Field components:- An array.
-
Uses template:
TicketConversation.
- [External]
-
The external fields URL address:
/admin/ticket_fields. The external fields list is extracted from:{{=Freshdesk.getCustomFields(response)}}.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/ticket_fields.Documentation: https://developer.freshdesk.com/api/#list_all_ticket_fields.
- [Read Single] action
-
Endpoint URL address:
/admin/ticket_fields/{{=parameters.id}}.Documentation: https://developer.freshdesk.com/api/#view_ticket_field.
- [Create] action
-
Endpoint URL address:
/admin/ticket_fields.Documentation: https://developer.freshdesk.com/api/#create_ticket_field.
- [Update] action
-
Endpoint URL address:
/admin/ticket_fields/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_ticket_field.
- [Delete] action
-
Endpoint URL address:
/admin/ticket_fields/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_ticket_field.
- id
A key field. Template: Id.
- name
Template: ShortText.
- label
Template: ShortText.
- label_for_customers
Template: ShortText.
- position
Template: Integer.
- type
Template: ShortText.
- default
Data type: DT_BOOL
- customers_can_edit
Data type: DT_BOOL
- required_for_closure
Data type: DT_BOOL
- required_for_agents
Data type: DT_BOOL
- required_for_customers
Data type: DT_BOOL
- displayed_to_customers
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- has_section
Data type: DT_BOOL
- sections
Field components:
- An array.
- Contains the following components: id, label, parent_ticket_field_id, choice_ids, ticket_field_ids.
- choices
Field components:
- An array.
-
Uses template:
Choice.
- section_mappings
Field components:
- An array.
- Contains the following components: section_id, position.
- dependent_fields
Field components:
- An array.
- Contains the following components: level, label, label_for_customers.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/admin/ticket_fields/{{=parameters.ticket_field_id}}/sections.
The result is extracted from:{{=response.sections}}.The action has the following user-defined parameters:
- ticket_field_id: Required. Specify the ticket field identifier.
Documentation: https://developer.freshdesk.com/api/#list_all_section_fields.
- [Read Single] action
-
Endpoint URL address:
/admin/ticket_fields/{{=parameters.ticket_field_id}}/sections/{{=parameters.id}}.
The result is extracted from:{{=[response.section]}}.The action has the following user-defined parameters:
- ticket_field_id: Required. Specify the ticket field identifier.
Documentation: https://developer.freshdesk.com/api/#list_specific_section.
- [Create] action
-
Endpoint URL address:
/admin/ticket_fields/{{=item.parent_ticket_field_id}}/sections.The following request parameters will be automatically processed:
-
application/json:
{{={ sections: item } }}
Documentation: https://developer.freshdesk.com/api/#create_section.
-
application/json:
- [Update] action
-
Endpoint URL address:
/admin/ticket_fields/{{=item.parent_ticket_field_id}}/sections/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ sections: item } }}
Documentation: https://developer.freshdesk.com/api/#update_section.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/admin/ticket_fields/{{=item.parent_ticket_field_id}}/sections/{{=item.id}}.The following request parameters will be automatically processed:
-
application/json:
{{={ sections: item } }}
Documentation: https://developer.freshdesk.com/api/#delete_section.
-
application/json:
- id
A key field. Template: Id.
- label
Template: ShortText.
- parent_ticket_field_id
A key field. Template: Id.
- choice_ids
Template: LongText. A composite field.
- ticket_field_ids
Template: LongText. A composite field.
- is_fsm
Data type: DT_BOOL
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/ticket-forms.Documentation: https://developer.freshdesk.com/api/#list_all_ticket_forms.
- [Read Single] action
-
Endpoint URL address:
/ticket-forms/{{=parameters.id}}.Documentation: https://developer.freshdesk.com/api/#view_ticket_form.
- [Create] action
-
Endpoint URL address:
/ticket-forms.Documentation: https://developer.freshdesk.com/api/#create_ticket_form.
- [Update] action
-
Endpoint URL address:
/ticket-forms/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_ticket_form.
- [Delete] action
-
Endpoint URL address:
/ticket-forms/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_ticket_form.
- id
A key field. Template: Id.
- name
Template: ShortText.
- title
Template: ShortText.
- default
Data type: DT_BOOL
- description
Template: LongText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- last_updated_by
Template: Id.
- portals
Template: LongText. A composite field.
- fields
Field components:
- An array.
-
Uses template:
TicketFormField.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/ticket-forms/{{=parameters.form_id}}/fields/{{=parameters.field_id}}.The action has the following user-defined parameters:
- form_id: Required. Specify the ticket form identifier.
- field_id: Required. Specify the ticket form field identifier.
Documentation: https://developer.freshdesk.com/api/#view_ticket_form_field.
- [Update] action
-
Endpoint URL address:
/ticket-forms/{{=item.form_id}}/fields/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_ticket_form_field.
- [Delete] action
-
Endpoint URL address:
/ticket-forms/{{=item.form_id}}/fields/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_ticket_form_field.
The resource includes the fields from the TicketFormField template.
- form_id
A key field. Template: Id.
Based on resource template Base.
- [Update] action
-
Endpoint URL address:
/conversations/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_conversation.
- [Delete] action
-
Endpoint URL address:
/conversations/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_conversation.
- id
A key field. Template: Id.
- body_text
Template: LongText.
- body
Template: LongText.
- incoming
Data type: DT_BOOL
- private
Data type: DT_BOOL
- user_id
Template: Id.
- support_email
Template: ShortText.
- ticket_id
Template: Id.
- notified_to
Template: LongText. A composite field.
- attachments
Field components:
- An array.
-
Uses template:
Attachment.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: create_reply, create_note.
-
Uses template:
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/account.
The result is extracted from:{{=[response]}}.Documentation: https://developer.freshdesk.com/api/#account.
- organisation_id
Template: Id.
- organisation_name
Template: ShortText.
- account_id
A key field. Template: Id.
- account_name
Template: ShortText.
- account_domain
Template: ShortText.
- bundle_id
Template: ShortText.
- hipaa_compliant
Data type: DT_BOOL
- total_agents
Field components:
-
Uses template:
Integer. - Contains the following components: full_time, occasional, field_service, collaborators.
-
Uses template:
- timezone
Template: ShortText.
- data_center
Template: ShortText.
- tier_type
Template: ShortText.
- address
Field components:
-
Uses template:
ShortText. - Contains the following components: country, state, city, street, postalcode.
-
Uses template:
- contact_person
Field components:
-
Uses template:
ShortText. - Contains the following components: firstname, lastname, email.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts.Documentation: https://developer.freshdesk.com/api/#list_all_contacts.
- [Read Filter] action
-
Endpoint URL address:
/search/contacts.
The result is extracted from:{{=response.results}}.
The result is paginated.The action has the following user-defined parameters:
- query: Required. Defines the filter query to execute. For example: "active:true".
The following request parameters will be automatically processed:
-
include:
{{=Freshdesk.getTicketExpandFields(parameters)}} -
per_page:
{{=undefined}}
Documentation: https://developer.freshdesk.com/api/#filter_contacts.
- [Read Single] action
-
Endpoint URL address:
/contacts/{{=parameters.id}}.Documentation: https://developer.freshdesk.com/api/#view_contact.
- [Create] action
-
Endpoint URL address:
/contacts.Documentation: https://developer.freshdesk.com/api/#create_contact.
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_contact.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.id}}/hard_delete.The following request parameters will be automatically processed:
-
force:
{{=parameters.get('force')}}
Documentation: https://developer.freshdesk.com/api/#hard_delete_contact.
-
force:
- id
A key field. Template: Id.
- active
Data type: DT_BOOL
- address
Template: ShortText.
- company_id
Template: Id.
- view_all_tickets
Data type: DT_BOOL
- description
Template: LongText.
- csat
Template: ShortText.
Template: ShortText.
- org_contact_id
Template: Id.
- org_contact_id_str
Template: ShortText.
- job_title
Template: ShortText.
- language
Template: ShortText.
- mobile
Template: ShortText.
- name
Template: ShortText.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- phone
Template: ShortText.
- preferred_source
Template: ShortText.
- time_zone
Template: ShortText.
- twitter_id
Template: ShortText.
- visitor_id
Template: ShortText.
- unique_external_id
Template: ShortText.
- facebook_id
Template: ShortText.
- language
Template: ShortText.
- other_emails
Template: LongText. A composite field.
- other_companies
Field components:
- An array.
- Contains the following components: company_id, view_all_tickets.
- other_phone_numbers
Field components:
- An array.
- Contains the following components: label, value.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- tags
Template: LongText. A composite field.
- avatar
Field components:
-
Uses template:
Id. - Contains the following components: id, avatar_url, content_type, name, size, created_at, updated_at.
-
Uses template:
- action
Template: ShortText. Field components:
-
Uses template:
ActionT. - Contains the following components: restore, merge.
-
Uses template:
- [External]
-
The external fields URL address:
/contact_fields. The external fields list is extracted from:{{=Freshdesk.getCustomFields(response)}}.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/contact_fields.Documentation: https://developer.freshdesk.com/api/#list_all_contact_fields.
- [Read Single] action
-
Endpoint URL address:
/contact_fields/{{=parameters.id}}.Documentation: https://developer.freshdesk.com/api/#view_contact_field.
- [Create] action
-
Endpoint URL address:
/contact_fields.Documentation: https://developer.freshdesk.com/api/#create_contact_field.
- [Update] action
-
Endpoint URL address:
/contact_fields/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_contact_field.
- [Delete] action
-
Endpoint URL address:
/contact_fields/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_contact_field.
- id
A key field. Template: Id.
- editable_in_signup
Data type: DT_BOOL
- name
Template: ShortText.
- label
Template: ShortText.
- position
Data type: DT_I4
- required_for_agents
Data type: DT_BOOL
- type
Template: ShortText.
- default
Data type: DT_BOOL
- customers_can_edit
Data type: DT_BOOL
- label_for_customers
Template: ShortText.
- required_for_customers
Data type: DT_BOOL
- displayed_for_customers
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- choices
Field components:
- An array.
-
Uses template:
Choice.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/agents.Documentation: https://developer.freshdesk.com/api/#list_all_agents.
- [Read Single] action
-
Endpoint URL address:
/agents/{{=parameters.id}}.Documentation: https://developer.freshdesk.com/api/#view_agent.
- [Read Search] action
-
Endpoint URL address:
/agents/autocomplete.The action has the following user-defined parameters:
- term: Required. Specify the search term.
Documentation: https://developer.freshdesk.com/api/#search_agents.
- [Read Current] action
-
Endpoint URL address:
/agents/me.
The result is extracted from:{{=[response]}}.Documentation: https://developer.freshdesk.com/api/#me.
- [Create] action
-
Endpoint URL address:
/agents.Documentation: https://developer.freshdesk.com/api/#create_agent.
- [Update] action
-
Endpoint URL address:
/agents/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_agent.
- [Delete] action
-
Endpoint URL address:
/agents/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_agent.
The resource includes the fields from the Agent template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/admin/skills.Documentation: https://developer.freshdesk.com/api/#list_all_skills.
- [Read Single] action
-
Endpoint URL address:
/admin/skills/{{=parameters.id}}.Documentation: https://developer.freshdesk.com/api/#view_skill.
- [Create] action
-
Endpoint URL address:
/admin/skills.Documentation: https://developer.freshdesk.com/api/#create_skill.
- [Update] action
-
Endpoint URL address:
/admin/skills/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_skill.
- [Delete] action
-
Endpoint URL address:
/admin/skills/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_skill.
- id
A key field. Template: Id.
- name
Template: ShortText.
- rank
Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- agents
Field components:
- An array.
- match_type
Template: ShortText.
- conditions
Field components:
- An array.
- Contains the following components: resource_type, field_name, operator, value.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/roles.Documentation: https://developer.freshdesk.com/api/#list_all_roles.
- [Read Single] action
-
Endpoint URL address:
/roles/{{=parameters.id}}.Documentation: https://developer.freshdesk.com/api/#view_role.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- default
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups.Documentation: https://developer.freshdesk.com/api/#list_all_groups.
- [Read Single] action
-
Endpoint URL address:
/groups/{{=parameters.id}}.Documentation: https://developer.freshdesk.com/api/#view_group.
- [Create] action
-
Endpoint URL address:
/groups.Documentation: https://developer.freshdesk.com/api/#create_group.
- [Update] action
-
Endpoint URL address:
/groups/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_group.
- [Delete] action
-
Endpoint URL address:
/groups/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_group.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- business_hour_id
Template: ShortText.
- group_type
Template: ShortText.
- escalate_to
Data type: DT_I4
- unassigned_for
Template: ShortText.
- agent_ids
Template: LongText. A composite field.
- auto_ticket_assign
Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- agent_availability_status
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/admin/groups.Documentation: https://developer.freshdesk.com/api/#list_all_admin_groups.
- [Read Single] action
-
Endpoint URL address:
/groups/{{=parameters.id}}.Documentation: https://developer.freshdesk.com/api/#view_admin_group.
- [Create] action
-
Endpoint URL address:
/admin/groups.Documentation: https://developer.freshdesk.com/api/#create_admin_group.
- [Update] action
-
Endpoint URL address:
/admin/groups/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_admin_group.
- [Delete] action
-
Endpoint URL address:
/admin/groups/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_admin_group.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- business_hour_id
Template: ShortText.
- group_type
Template: ShortText.
- escalate_to
Data type: DT_I4
- unassigned_for
Template: ShortText.
- agent_ids
Template: LongText. A composite field.
- auto_ticket_assign
Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- agent_availability_status
Data type: DT_BOOL
- agents
The value is gathered from
/admin/groups/{{=item.id}}/agentsaddress. Field components:- An array.
-
Uses template:
Agent.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies.Documentation: https://developer.freshdesk.com/api/#list_all_companies.
- [Read Filter] action
-
Endpoint URL address:
/search/companies.
The result is extracted from:{{=response.results}}.
The result is paginated.The action has the following user-defined parameters:
- query: Required. Defines the filter query to execute. For example: "private:true".
The following request parameters will be automatically processed:
-
per_page:
{{=undefined}}
Documentation: https://developer.freshdesk.com/api/#filter_companies.
- [Read Single] action
-
Endpoint URL address:
/companies/{{=parameters.id}}.Documentation: https://developer.freshdesk.com/api/#view_company.
- [Create] action
-
Endpoint URL address:
/companies.Documentation: https://developer.freshdesk.com/api/#create_company.
- [Update] action
-
Endpoint URL address:
/companies/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_company.
- [Delete] action
-
Endpoint URL address:
/companies/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_company.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- domains
Template: LongText. A composite field.
- note
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- health_score
Template: ShortText.
- account_tier
Template: ShortText.
- renewal_date
Template: DateTime.
- industry
Template: ShortText.
- account_tier
Template: ShortText.
- org_company_id
Template: Id.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/company_fields.Documentation: https://developer.freshdesk.com/api/#list_all_company_fields.
- [Read Single] action
-
Endpoint URL address:
/company_fields/{{=parameters.id}}.Documentation: https://developer.freshdesk.com/api/#view_company_field.
- [Create] action
-
Endpoint URL address:
/company_fields.Documentation: https://developer.freshdesk.com/api/#create_company_field.
- [Update] action
-
Endpoint URL address:
/company_fields/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_company_field.
- [Delete] action
-
Endpoint URL address:
/company_fields/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_company_field.
- id
A key field. Template: Id.
- name
Template: ShortText.
- label
Template: ShortText.
- position
Template: Integer.
- type
Template: ShortText.
- default
Data type: DT_BOOL
- required_for_agents
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- choices
Field components:
- An array.
-
Uses template:
Choice.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/canned_responses/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the canned response identifier.
Documentation: https://developer.freshdesk.com/api/#view_canned_response.
- [Create] action
-
Endpoint URL address:
/canned_responses.Documentation: https://developer.freshdesk.com/api/#create_canned_response.
- [Update] action
-
Endpoint URL address:
/canned_responses/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_canned_response.
- id
A key field. Template: Id.
- title
Template: ShortText.
- folder_id
Template: Id.
- visibility
Template: Integer.
- content
Template: LongText.
- content_html
Template: LongText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- group_ids
Template: LongText. A composite field.
- attachments
Field components:
- An array.
-
Uses template:
Attachment.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/canned_response_folders.Documentation: https://developer.freshdesk.com/api/#list_all_canned_response_folders.
- [Create] action
-
Endpoint URL address:
/canned_response_folders.Documentation: https://developer.freshdesk.com/api/#create_canned_response_folder.
- [Update] action
-
Endpoint URL address:
/canned_response_folders/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_canned_response_folder.
- id
A key field. Template: Id.
- name
Template: ShortText.
- response_count
Template: Integer.
- personal
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- canned_responses
The value is gathered from
/canned_response_folders/{{=item.id}}/responsesaddress. Field components:- An array.
-
Uses template:
CannedResponse.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/discussions/categories.
- [Create] action
-
Endpoint URL address:
/discussions/categories.
- [Update] action
-
Endpoint URL address:
/discussions/categories/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/discussions/categories/{{=item.id}}.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/discussions/forums/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the forum identifier.
- [Create] action
-
Endpoint URL address:
/discussions/categories/{{=item.forum_category_id}}/forums.
- [Update] action
-
Endpoint URL address:
/discussions/forums/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/discussions/forums/{{=item.id}}.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- position
Data type: DT_I4
- forum_category_id
Template: Id.
- forum_type
Data type: DT_I4
- forum_visibility
Data type: DT_I4
- topics_count
Data type: DT_I4
- posts_count
Data type: DT_I4
- company_ids
Template: LongText. A composite field.
- topic
The value is gathered from
/discussions/forums/{{=item.id}}/topicsaddress. Field components:- An array.
-
Uses template:
Topic.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/discussions/topics/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the topic identifier.
- [Create] action
-
Endpoint URL address:
/discussions/categories/{{=item.category_id}}/topics.
- [Update] action
-
Endpoint URL address:
/discussions/topics/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/discussions/topics/{{=item.id}}.
The resource includes the fields from the Topic template.
- category_id
A key field. Template: Id.
- comments
The value is gathered from
/discussions/forums/{{=item.id}}/commentsaddress. Field components:- An array.
-
Uses template:
Comment.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/discussions/comments/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the topic identifier.
- [Create] action
-
Endpoint URL address:
/discussions/categories/{{=item.category_id}}/comments.
- [Update] action
-
Endpoint URL address:
/discussions/comments/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/discussions/comments/{{=item.id}}.
The resource includes the fields from the Comment template.
- category_id
A key field. Template: Id.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/solutions/categories.
- [Read Single] action
-
Endpoint URL address:
/solutions/categories/{{=parameters.id}}.
- [Create] action
-
Endpoint URL address:
/solutions/categories.
- [Update] action
-
Endpoint URL address:
/solutions/categories/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/solutions/categories/{{=item.id}}.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- folders
The value is gathered from
/solutions/categories/{{=item.id}}/foldersaddress. Field components:- An array.
-
Uses template:
Folder.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/solutions/categories/{{=parameters.category_id}}/folders.The action has the following user-defined parameters:
- category_id: Required. Specify the category identifier.
- [Read Single] action
-
Endpoint URL address:
/solutions/folders/{{=parameters.id}}.
- [Create] action
-
Endpoint URL address:
/solutions/categories/{{=item.category_id}}/folders.
- [Update] action
-
Endpoint URL address:
/solutions/folders/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/solutions/folders/{{=item.id}}.
The resource includes the fields from the Folder template.
- articles
The value is gathered from
/solutions/folders/{{=item.id}}/articlesaddress. Field components:- An array.
-
Uses template:
Article.
Based on resource template NoPagination.
- [Read Search] action
-
Endpoint URL address:
/search/solutions.The action has the following user-defined parameters:
- term: Required. Specify to search the articles in your Freshdesk account using a keyword.
- [Read Single] action
-
Endpoint URL address:
/solutions/articles/{{=parameters.id}}.
- [Create] action
-
Endpoint URL address:
/solutions/folders/{{=item.folder_id}}/articles.
- [Update] action
-
Endpoint URL address:
/solutions/articles/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/solutions/articles/{{=item.id}}.
The resource includes the fields from the Article template.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/surveys.Documentation: https://developer.freshdesk.com/api/#solution_folder_attributes.
- id
A key field. Template: Id.
- title
Template: ShortText.
- active
Data type: DT_BOOL
- questions
Field components:
- An array.
- Contains the following components: id, label, accepted_ratings.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/surveys/satisfaction_ratings.Documentation: https://developer.freshdesk.com/api/#view_all_satisfaction_ratings.
- [Create] action
-
Endpoint URL address:
/tickets/{{=item.id}}/satisfaction_ratings.Documentation: https://developer.freshdesk.com/api/#create_satisfaction_rating.
- id
A key field. Template: Id.
- survey_id
Template: Id.
- user_id
Template: Id.
- agent_id
Template: Id.
- feedback
Template: ShortText.
- group_id
Template: Id.
- ticket_id
Template: Id.
- ratings
Field components:
- Contains the following components: default_question, question_2.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/groups/{{=parameters.id}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify the group identifier.
- [Create] action
-
Endpoint URL address:
/groups.
- [Update] action
-
Endpoint URL address:
/groups/{{=item.id}}.
- [Delete] action
-
Endpoint URL address:
/groups/{{=item.id}}.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- escalate_to
Data type: DT_I4
- unassigned_for
Template: ShortText.
- business_hour_id
Template: ShortText.
- auto_ticket_assign
Data type: DT_BOOL
- group_type
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- agent_ids
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/time_entries.Documentation: https://developer.freshdesk.com/api/#list_all_time_entries.
- [Create] action
-
Endpoint URL address:
/time_entries.Documentation: https://developer.freshdesk.com/api/#create_time_entry.
- [Update] action
-
Endpoint URL address:
/time_entries/{{=item.id}}.Documentation: http://developer.freshdesk.com/api/#update_time_entry.
- [Delete] action
-
Endpoint URL address:
/time_entries/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_time_entry.
- id
A key field. Template: Id.
- billable
Data type: DT_BOOL
- note
Template: LongText.
- timer_running
Data type: DT_BOOL
- agent_id
Template: Id.
- ticket_id
Template: Id.
- company_id
Template: Id.
- time_spent
Template: ShortText.
- time_spent_in_seconds
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- executed_at
Template: DateTime. A read-only field.
- start_time
Template: DateTime.
- time_running
Data type: DT_BOOL
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/email_configs.Documentation: https://developer.freshdesk.com/api/#list_all_email_configs.
- [Read Single] action
-
Endpoint URL address:
/email_configs/{{=parameters.id}}.Documentation: https://developer.freshdesk.com/api/#view_email_config.
- id
A key field. Template: Id.
- name
Template: ShortText.
- product_id
Template: Id.
- to_email
Template: ShortText.
- reply_email
Template: ShortText.
- group_id
Template: Id.
- primary_role
Data type: DT_BOOL
- active
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/email/mailboxes.Documentation: https://developer.freshdesk.com/api/#list_all_email_mailboxes.
- [Read Single] action
-
Endpoint URL address:
/email/mailboxes/{{=parameters.id}}.Documentation: https://developer.freshdesk.com/api/#view_email_mailbox.
- [Create] action
-
Endpoint URL address:
/email/mailboxes.Documentation: https://developer.freshdesk.com/api/#create_email_mailbox.
- [Update] action
-
Endpoint URL address:
/email/mailboxes/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_email_mailbox.
- [Delete] action
-
Endpoint URL address:
/email/mailboxes/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_email_mailbox.
- id
A key field. Template: Id.
- name
Template: ShortText.
- support_email
Template: ShortText.
- group_id
Template: Id.
- default_reply_email
Data type: DT_BOOL
- active
Data type: DT_BOOL
- mailbox_type
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- product_id
Template: Id.
- custom_mailbox
Field components:
-
Uses template:
ShortText. - Contains the following components: access_type, incoming, outgoing.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/products.Documentation: https://developer.freshdesk.com/api/#list_all_products.
- [Read Single] action
-
Endpoint URL address:
/products/{{=parameters.id}}.Documentation: https://developer.freshdesk.com/api/#view_product.
- id
A key field. Template: Id.
- name
Template: ShortText.
- primary_email
Template: ShortText.
- default
Data type: DT_BOOL
- description
Template: LongText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/business_hours.Documentation: https://developer.freshdesk.com/api/#list_all_business_hours.
- [Read Single] action
-
Endpoint URL address:
/business_hours/{{=parameters.id}}.Documentation: https://developer.freshdesk.com/api/#view_business_hour.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: ShortText.
- time_zone
Template: ShortText.
- is_default
Data type: DT_BOOL
- business_hours
Field components:
-
Uses template:
BusinessHour. - Contains the following components: monday, tuesday, wednesday, thursday, friday.
-
Uses template:
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/scenario_automations.json.Documentation: https://developer.freshdesk.com/api/#list_all_scenario_automations.
- id
Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- actions
Field components:
- An array.
- Contains the following components: name, value.
- private
Data type: DT_BOOL
- created_at
Template: DateTime.
- updated_at
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/sla_policies.Documentation: https://developer.freshdesk.com/api/#list_all_sla_policies.
- [Create] action
-
Endpoint URL address:
/sla_policies.Documentation: https://developer.freshdesk.com/api/#create_sla_policy.
- [Update] action
-
Endpoint URL address:
/sla_policies/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#create_sla_policy.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- active
Data type: DT_BOOL
- is_default
Data type: DT_BOOL
- position
Data type: DT_I4
- sla_target
Template: SlaTarget.
- applicable_to
Template: ApplicableTo.
- escalation
Field components:
-
Uses template:
Escalation. - Contains the following components: response, resolution.
-
Uses template:
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/automations/{{=parameters.automation_type_id}}/rules.
The result is extracted from:{{=response.rules}}.The action has the following user-defined parameters:
- automation_type_id: Required. Specify the automation type identifier.
Documentation: https://developer.freshdesk.com/api/#list_all_automation_rules.
- [Read Single] action
-
Endpoint URL address:
/automations/{{=parameters.automation_type_id}}/rules/{{=parameters.id}}.The action has the following user-defined parameters:
- automation_type_id: Required. Specify the automation type identifier.
Documentation: https://developer.freshdesk.com/api/#view_an_automation_rule.
- [Create] action
-
Endpoint URL address:
/automations/{{=item.automation_type_id}}/rules.Documentation: https://developer.freshdesk.com/api/#create_an_automation_rule.
- [Update] action
-
Endpoint URL address:
/automations/{{=item.automation_type_id}}/rules/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_an_automation_rule.
- [Delete] action
-
Endpoint URL address:
/automations/{{=item.automation_type_id}}/rules/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_an_automation_rule.
- id
A key field. Template: Id.
- name
Template: ShortText.
- position
Data type: DT_I4
- active
Data type: DT_BOOL
- automation_type_id
A key field. Template: Id.
- performer
Field components:
-
Uses template:
ShortText. - Contains the following components: type, members.
-
Uses template:
- events
Field components:
- An array.
-
Uses template:
Event.
- conditions
Field components:
- An array.
- Contains the following components: name, match_type, properties.
- operator
Template: ShortText.
- actions
Field components:
- An array.
- Contains the following components: field_name, value, email_to, email_body, api_key, auth_header, custom_headers, content, request_type, url, note_body, notify_agents, nested_fields, fwd_to, fwd_cc, fwd_bcc, fwd_note_body, push_to, slack_text, office365_text, resource_type.
- outdated
Data type: DT_BOOL
- last_updated_by
Template: Id.
- affected_tickets_count
Data type: DT_I4
- Summary
Field components:
-
Uses template:
ShortText. - Contains the following components: performer, events, conditions, actions.
-
Uses template:
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/settings/helpdesk.
The result is extracted from:{{=[response]}}.Documentation: https://developer.freshdesk.com/api/#settings_helpdesk.
- primary_language
Template: ShortText.
- supported_languages
Template: LongText. A composite field.
- portal_languages
Template: LongText. A composite field.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/collaboration/threads/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. Specify the thread identifier.
Documentation: https://developer.freshdesk.com/api/#get_a_thread.
- [Create] action
-
Endpoint URL address:
/collaboration/threads.Documentation: https://developer.freshdesk.com/api/#create_a_thread.
- [Update] action
-
Endpoint URL address:
/collaboration/threads/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_a_thread.
- [Delete] action
-
Endpoint URL address:
/collaboration/threads/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_a_thread.
- id
A key field. Template: Id.
- type
Template: ShortText.
- title
Template: ShortText.
- created_by
Template: ShortText.
- parent
Template: GeneralThread.
- anchor
Template: GeneralThread.
- participants
Field components:
-
Uses template:
LongText. - Contains the following components: emails, agents.
-
Uses template:
- linked_object
Template: GeneralThread. Field components:
- Contains the following components: attributes, links.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- additional_info
Field components:
-
Uses template:
Id. - Contains the following components: email_config_id.
-
Uses template:
- is_read
Data type: DT_BOOL
- updated_by
Template: ShortText.
Based on resource template NoPagination.
- [Read] action
-
Endpoint URL address:
/collaboration/messages/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. Specify the message identifier.
Documentation: https://developer.freshdesk.com/api/#get_message_for_thread.
- [Create] action
-
Endpoint URL address:
/collaboration/messages.Documentation: https://developer.freshdesk.com/api/#create_a_thread.
- [Update] action
-
Endpoint URL address:
/collaboration/messages/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#update_a_thread.
- [Delete] action
-
Endpoint URL address:
/collaboration/messages/{{=item.id}}.Documentation: https://developer.freshdesk.com/api/#delete_a_thread.
- id
A key field. Template: Id.
- body
Template: LongText.
- body_text
Template: LongText.
- thread_id
Template: Id.
- created_by
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- attachment_ids
Template: LongText. A composite field.
- inline_attachment_ids
Template: ShortText.
- participants
Field components:
-
Uses template:
ShortText. - Contains the following components: email, tagged_users.
-
Uses template:
- edited
Data type: DT_BOOL
- source
Data type: DT_I4
- additional_info
Field components:
-
Uses template:
ShortText. - Contains the following components: skip_notification, auto_response, number_of_failed_emails, has_quoted_text, failed_emails_info, email_subject.
-
Uses template:
- [Read] action
-
Endpoint URL address:
/custom_objects/schemas/{{=resource.external.id}}/records.Documentation: https://developer.freshdesk.com/api/#retrieve_all_the_records_of_a_custom_object.
- [Read Single] action
-
Endpoint URL address:
/custom_objects/schemas/{{=resource.external.id}}/records/{{=parameters.id}}.Documentation: https://developer.freshdesk.com/api/#retrieve_a_custom_object_record.
- [Create] action
-
Endpoint URL address:
/custom_objects/schemas/{{=resource.external.id}}/records.Documentation: https://developer.freshdesk.com/api/#create_a_new_custom_object_record.
- [Update] action
-
Endpoint URL address:
/custom_objects/schemas/{{=resource.external.id}}/records/{{=item.display_id}}.Documentation: https://developer.veevavault.com/api/24.2/#update-object-records.
- [Delete] action
-
Endpoint URL address:
/custom_objects/schemas/{{=resource.external.id}}/records/{{=item.display_id}}.Documentation: https://developer.freshdesk.com/api/#delete_a_custom_object_record.
- display_id
A key field. Template: ShortText.
- created_time
Template: UnixTime. A read-only field.
- updated_time
Template: UnixTime. A read-only field.
- version
Template: Integer.
- [External]
-
The external fields URL address:
/custom_objects/schemas/{{=resource.external.id}}. The external fields list is extracted from:{{=response.fields}}.- {{=external.name}}
Template: {{=Freshdesk.getFieldTemplate(external.type)}}. ( length {{=external.maxLength || 250}} )
The external resource list URL address: /custom_objects/schemas.
The external resource list is extracted from: {{=response.schemas}}.
Based on resource template Cursor.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
per_page:
{{=parameters.batchSize}} -
page:
{{=parameters.iterator}} -
_includeUserParameters:
{{=parameters}}
-
per_page:
- [Read Single] action
-
The result is extracted from:{{=[response]}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Specify record identifier.
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
Based on resource template Base.
- [Read] action
-
The result is extracted from:{{=response.records}}.
The result is paginated.The following request parameters will be automatically processed:
-
page_size:
{{=parameters.batchSize}} -
next_token:
{{=parameters.iterator}} -
per_page:
{{=undefined}} -
page:
{{=undefined}}
-
page_size:
Based on resource template Base.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
per_page:
{{=undefined}} -
page:
{{=undefined}} -
_includeUserParameters:
{{=parameters}}
-
per_page:
- ShortText
Data type: DT_WSTR ( length 250 )
- LongText
Data type: DT_WSTR ( length 4000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Integer
Data type: DT_I4
- Id
Data type: DT_I8
- Decimal
Data type: DT_R8
- MultiSelect
Template: ShortText. The gathered value is processed with
{{=value && value.join('|')}}expression. Before setting, the value is processed with{{=value && value.split('|').map(function(v) { return v.trim(); }) }}expression.- UnixTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=value && new Date(parseFloat(value)).toUTCString()}}expression. Before setting, the value is processed with{{=value && new Date(value).valueOf()}}expression.- SlaPriority
Field components:
- Contains the following components: respond_within, resolve_within, next_respond_within, business_hours, escalation_enabled.
- Associated
Field components:
-
Uses template:
Id. - Contains the following components: id, group_id, priority, requester_id, responder_id, created_at, updated_at, product_id, company_id, status, subject, source, type, due_by, fr_due_by, is_escalated.
-
Uses template:
- TicketSummary
Field components:
-
Uses template:
Id. - Contains the following components: id, body, body_text, user_id, ticket_id, created_at, updated_at, attachments, last_edited_at, last_edited_user_id, cloud_files.
-
Uses template:
- TicketRating
Field components:
-
Uses template:
Id. - Contains the following components: id, survey_id, user_id, agent_id, feedback, group_id, ticket_id, ratings, created_at, updated_at.
-
Uses template:
- Choice
Field components:
-
Uses template:
Id. - Contains the following components: id, position, value, parent_choice_id, choices.
-
Uses template:
- TicketEntry
Field components:
-
Uses template:
Id. - Contains the following components: id, billable, note, timer_running, agent_id, ticket_id, company_id, time_spent, executed_at, start_time, created_at, updated_at, time_spent_in_seconds.
-
Uses template:
- TicketConversation
Field components:
-
Uses template:
Id. - Contains the following components: id, body, body_text, structured_body, incoming, private, user_id, support_email, source, category, to_emails, from_email, cc_emails, bcc_emails, email_failure_count, outgoing_failures, thread_id, thread_message_id, created_at, updated_at, last_edited_at, last_edited_user_id, attachments, automation_id, automation_type_id, auto_response, ticket_id, threading_type, delivery_details, source_additional_info, auto_response, delivery_details, outgoing_failures, email_failure_count.
-
Uses template:
- TicketFormField
Field components:
-
Uses template:
Id. - Contains the following components: id, name, label, label_for_customers, position, type, default, customers_can_edit, required_for_closure, required_for_agents, required_for_customers, displayed_to_customers, created_at, updated_at, archived, portal_cc, portal_cc_to.
-
Uses template:
- Attachment
Field components:
-
Uses template:
Id. - Contains the following components: id, content_type, file_size, name, attachment_url, created_at, updated_at, size, thumb_url.
-
Uses template:
- Agent
Field components:
-
Uses template:
Id. - Contains the following components: id, available, occasional, signature, group_ids, role_ids, skill_ids, ticket_scope, created_at, updated_at, available_since, type, name, email, avatar, contact, focus_mode.
-
Uses template:
- CannedResponse
Field components:
-
Uses template:
Id. - Contains the following components: id, title, folder_id, visibility, content, content_html, attachments, created_at, updated_at, group_ids, attachments.
-
Uses template:
- Topic
Field components:
-
Uses template:
Id. - Contains the following components: id, title, forum_id, user_id, locked, published, stamp_type, replied_by, posts_count, hits, user_votes, merged_topic_id, sticky, created_at, updated_at, replied_at.
-
Uses template:
- Comment
Field components:
-
Uses template:
Id. - Contains the following components: id, body_text, body, topic_id, forum_id, user_id, answer, published, spam, trash, created_at, updated_at.
-
Uses template:
- FolderHierarchy
Field components:
-
Uses template:
ShortText. - Contains the following components: level, type, data.
-
Uses template:
- Folder
Field components:
-
Uses template:
Id. - Contains the following components: id, name, description, parent_folder_id, hierarchy, articles_count, sub_folders_count, visibility, category_id, created_at, updated_at, company_segment_ids, company_ids, contact_segment_ids.
-
Uses template:
- Metadata
The gathered value is processed with
{{=_.map(value, function(v, k) { return { name: k, value: v }; })}}expression. Field components:- An array.
- Contains the following components: name, value.
- Article
Field components:
-
Uses template:
Id. - Contains the following components: id, type, category_id, folder_id, hierarchy, thumbs_up, thumbs_down, hits, tags, seo_data, agent_id, title, description, description_text, status, created_at, updated_at.
-
Uses template:
- BusinessHour
Field components:
-
Uses template:
ShortText. - Contains the following components: start_time, end_time.
-
Uses template:
- Escalation
Field components:
-
Uses template:
LongText. - Contains the following components: escalation_time, agent_ids.
-
Uses template:
- EventLevel
Field components:
-
Uses template:
ShortText. - Contains the following components: field_name, operator, value.
-
Uses template:
- Event
Field components:
-
Uses template:
ShortText. - Contains the following components: field_name, from, to, value, from_nested_field, to_nested_field.
-
Uses template:
- Condition
Field components:
-
Uses template:
ShortText. - Contains the following components: field_name, operator, value.
-
Uses template:
- MailboxSetting
Field components:
-
Uses template:
ShortText. - Contains the following components: mail_server, port, use_ssl, delete_from_server, authentication, user_name, failure_code.
-
Uses template:
- SlaTarget
Field components:
-
Uses template:
SlaPriority. - Contains the following components: priority_4, priority_3, priority_2, priority_1.
-
Uses template:
- ApplicableTo
Field components:
-
Uses template:
LongText. - Contains the following components: company_ids, group_ids, sources, ticket_types, product_ids.
-
Uses template:
- GeneralThread
Field components:
-
Uses template:
Id. - Contains the following components: id, type.
-
Uses template:
- ActionT
Knowledge Base
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.