Freshservice
Retrieves the domain name assigned by Freshservice for an account.
call - Trigger the retrieval of the domain name.
onSuccess - Trigger an action when the domain name is successfully retrieved.
onError - Trigger an action when the method returns an error message due to failed operation.
Retrieves the information of an agent who is currently logged into the Freshdesk UI.
call - Trigger the retrieval of the agent information.
onSuccess - Trigger an action when the logged-in user is successfully retrieved.
onError - Trigger an action when the method returns an error message due to failed operation.
Retrieves the information corresponding to a ticket.
call - Trigger the retrieval of the corresponding ticket information.
onSuccess - Trigger an action when the ticket information is successfully retrieved.
onError - Trigger an action when the method returns an error message due to failed operation.
show - Trigger an action to display a ticket field on the Ticket Details page.
hide - Trigger an action to hide a ticket field on the Ticket Details page.
Parameters | Type | Description |
|---|---|---|
id | String | The field name to be shown/hidden.
Available options: status, priority, ticket_type, group, product, custom_field, and tag.
Note: For the custom field, the name should be the name of your field. |
onSuccess - Trigger an action when the ticket field is successfully shown or hidden.
onError - Trigger an action when the method returns an error message due to failed operation.
Enables or disables a particular ticket field on the Ticket Details page.
enable - Trigger an action to enable a ticket field on the Ticket Details page.
disable - Trigger an action to disable a ticket field on the Ticket Details page.
Parameters | Type | Description |
|---|---|---|
id | String | The field name to be enabled/disabled.
Available options: status, priority, ticket_type, group, product, custom_field, and tag.
Note: For the custom field, the name should be the name of your field. |
onSuccess - Trigger an action when the ticket field is successfully enabled or disabled from the Ticket Details page.
onError - Trigger an action when the method returns an error message due to failed operation.
Enables the app to define values for a ticket field displayed on the Ticket Details page.
call - Trigger an action to set specific values for a ticket field displayed on the Ticket details page.
Parameters | Type | Description |
|---|---|---|
id | String | The field name to set a value for. Available options: status, priority, ticket_type, group, agent, product, and cf_custom_field.
Note: For the custom field, the name should be the name of your field. |
value | Number/String | Value to be set for the respective ticket field.
Note: Some ticket fields require the respective number to be added as value. Refer to API docs for these values. |
onSuccess - Trigger an action when the values for a ticket field are successfully defined.
onError - Trigger an action when the method returns an error message due to failed operation.
Starts or stops the ticket timer on the Ticket Details page.
start - Trigger an action to start or create a new timer on the Ticket Details page.
Parameters | Type | Description |
|---|---|---|
value | Object | It accepts an Object with the following information.
agent: (number) The agent to whom this time-entry is associated. billable: (boolean) Set as true if the entry is billable. note: (string) Description for this time-entry
For example: {"agent": 123, billable: true, note: "Some text"}} |
toggle - Trigger an action to toggle the timer that is already running or stopped.
Parameters | Type | Description |
|---|---|---|
value | String | It accepts a String with the ID of the time entry that needs to be updated. |
onSuccess - Trigger an action when the timer is started or toggled successfully.
onError - Trigger an action when the method returns an error message due to failed operation.
Displays the entire conversation history associated with a specific ticket.
call - Trigger an action to display all the notes and replies added to a ticket.
onSuccess - Trigger an action when the entire ticket conversation can be viewed on the Ticket Details page.
onError - Trigger an action when the method returns an error message due to failed operation.
Enables the app to open the editor to add note or reply and add the given input text.
call - Trigger an action to enable the app to open a note attached to the ticket and add a reply to it.
Parameters | Type | Description |
|---|---|---|
type | Drop-down | Drop-down to choose Note or Reply to be added. |
text | String | Text to be inserted in the editor window. |
onSuccess - Trigger an action when the method enables the user to open a note and add a reply.
onError - Trigger an action when the method returns an error message due to failed operation.
Enables the app to submit the updated ticket field values on the Ticket Details page.
call - Trigger an action to submit the updated ticket field values on the Ticket details page.
onSuccess - Trigger an action when the ticket field values are successfully submitted.
onError - Trigger an action when the method returns an error message due to failed operation.
Retrieves the information of the requester.
call - Trigger an action to retrieve information about the requester.
onSuccess - Trigger an action when the details of the requestor are successfully retrieved.
onError - Trigger an action when the method returns an error message due to failed operation.
Retrieves the information of the agent.
call - Trigger an action to retrieve information about the agent.
onSuccess - Trigger an action when the details of the agent are successfully retrieved.
onError - Trigger an action when the method returns an error message due to failed operation.
Retrieves the information of the department.
call - Trigger an action to retrieve information about the department.
onSuccess - Trigger an action when the details of the department are successfully retrieved.
onError - Trigger an action when the method returns an error message due to failed operation.
Retrieves the information of the group.
call - Trigger an action to retrieve information about the group.
onSuccess - Trigger an action when the details of the group are successfully retrieved.
onError - Trigger an action when the method returns an error message due to failed operation.
Retrieves the information of the Problem associated with the ticket.
call - Trigger an action to retrieve information about the Problem associated with the ticket.
onSuccess - Trigger an action when the details of the Problem associated with the ticket are successfully retrieved.
onError - Trigger an action when the method returns an error message due to failed operation.
Retrieves the information of the Change associated with the ticket.
call - Trigger an action to retrieve information about the Change associated with the ticket.
onSuccess - Trigger an action when the details of the Change associated with the ticket are successfully retrieved.
onError - Trigger an action when the method returns an error message due to failed operation.
Retrieves the information of the Tasks associated with the ticket.
call - Trigger an action to retrieve information about the Tasks associated with the ticket.
onSuccess - Trigger an action when the details of the Tasks associated with the ticket are successfully retrieved.
onError - Trigger an action when the method returns an error message due to failed operation.
Retrieves the list of child tickets associated with the ticket.
call - Trigger an action to retrieve the information about the recent child tickets associated with the ticket.
onSuccess - Trigger an action when the details of the recent child tickets are successfully retrieved.
onError - Trigger an action when the method returns an error message due to failed operation.
Retrieves the list of assets associated with the requester.
call - Trigger an action to retrieve the information about the assets associated with the requester.
onSuccess - Trigger an action when the details of the assets associated with the requester are successfully retrieved.
onError - Trigger an action when the method returns an error message due to failed operation.
Retrieves the list of assets associated with the ticket.
call - Trigger an action to retrieve the information about the assets associated with the ticket.
onSuccess - Trigger an action when the details of the assets associated with the ticket are successfully retrieved.
onError - Trigger an action when the method returns an error message due to failed operation.
Enables the app to display different types of notifications on the user interface.
call - Trigger an action to display notifications on the user interface.
Parameters | Type | Description |
|---|---|---|
type | Drop-down | Drop-down to choose the type of notification.
Options: Success, Warning, Info, Danger and Alert. |
message | String | Message to be displayed in the notification. |
title | String | Title to be displayed in the notification. |
onSuccess - Trigger an action when the notifications are successfully displayed in the User Interface.
onError - Trigger an action when the method returns an error message due to failed operation.
Enables the app to function based on the registered ticket fields event on the New Ticket Page.
registerEvent - Trigger the registration of an event on the New Ticket Page.
unregisterEvent - Trigger the deregistration of an event on the New Ticket Page.
Parameters | Type | Description |
|---|---|---|
eventName | Drop-down | Indicates the name of the event that is registered/deregistered in the app. |
onTrigger - Triggers an action when a change event pertaining to a ticket is triggered.
event - Information about the event that is triggered.
Enables the app to function based on the registered ticket fields change event on the Ticket Details Page.
registerEvent - Trigger the registration of a change event.
unregisterEvent - Trigger the deregistration of a change event.
Parameters | Type | Description |
|---|---|---|
eventName | Drop-down | Indicates the name of the change event that is registered/deregistered in the app. |
onTrigger - Triggers an action when a change event pertaining to a ticket is triggered.
Enables the app to function based on the registered ticket fields click event on the Ticket Details Page.
registerEvent - Trigger the registration of a click event.
unregisterEvent - Trigger the deregistration of a click event.
Parameters | Type | Description |
|---|---|---|
eventName | Drop-down | Indicates the name of the click event that is registered/deregistered in the app. |
onTrigger - Triggers an action when a click event pertaining to a ticket is triggered.