# Freshdesk

## Introduction

This document serves as a guide to integrating the Freshdesk customer support platform with Autom Mate. Freshdesk, developed by Freshworks, is a cloud-based solution designed to streamline customer support processes, manage tickets, and enhance overall customer satisfaction. This integration with Autom Mate enables users to perform various actions within Freshdesk directly from the Autom Mate platform, providing a seamless workflow for customer support tasks.

## What is Freshdesk?

Freshdesk is a versatile customer support platform that offers features such as ticket management, multi-channel support, knowledge base management, and automation tools. It aims to simplify customer interactions, improve ticket resolution times, and optimize support workflows for businesses of all sizes.

## Autom Mate Integration with Freshdesk

The integration between Autom Mate and Freshdesk brings together the power of streamlined automation and robust customer support management. By seamlessly connecting these platforms, users gain the ability to effortlessly perform a variety of tasks within Freshdesk directly from the Autom Mate platform. Whether it's updating ticket information, creating new support requests, retrieving user details, accessing attachment contents, or fetching the latest ticket conversations, this integration simplifies and accelerates critical customer support processes. With Autom Mate's intuitive interface and Freshdesk's comprehensive features, businesses can enhance their support workflows, improve efficiency, and ultimately deliver exceptional customer experiences.

## Using the Integration

To begin using the Freshdesk App integration with Autom Mate, follow these steps:

### Credentials

1. Sign in to your Autom Mate account.
2. Go to the [Vault ](https://docs.autommate.com/userguide/product-features/management/vault)page under Management.
3. Navigate to the Freshdesk App integration section.
4. Enter your Freshdesk credentials, including the API Key and Domain, to establish a connection.
5. Save the credentials to enable the integration.

## How To Use Actions

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FZ1OFEZyLnYe7GBMqba5u%2Fuploads%2FMICy389Zfpc0uJLfw0Qa%2Ffreshdesk%20(2).mp4?alt=media&token=2d7e9d77-9567-4bbb-ab14-509aec728ee4>" %}
Sample Implementation of Freshdesk into the Autom Mate
{% endembed %}

### Add Note

<figure><img src="https://4222414448-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMAf5diEa8kgXDA6h47Cu%2Fuploads%2FztFotEPutqfbbPqM8Ftf%2Fimage.png?alt=media&#x26;token=ba06ead0-a757-4f45-a7eb-9a7292f54efc" alt=""><figcaption></figcaption></figure>

To add a note to an existing ticket in Freshdesk, follow these steps:

**Description:** Adds a new note to an existing ticket in Freshdesk.

**Purpose:** To update ticket information with additional notes or comments.

**Usage:**

1. Click on the "Add Note" action.
2. Enter the Ticket ID of the ticket you wish to update.
3. Choose whether the note should be Private or Public.
4. Provide the User ID of the person adding the note.
5. Input the Note Content and attach files if needed.
6. Execute the action to update the ticket with the note.

**Inputs:**

* **Ticket ID:** <mark style="color:green;">The ID of the ticket to update.</mark>
* **Note Type:** <mark style="color:green;">Private or Public.</mark>
* **User ID:** <mark style="color:green;">The ID of the user adding the note.</mark>
* **Note Content:** <mark style="color:green;">The text content of the note.</mark>
* **Attachments:** <mark style="color:green;">Any files to attach to the note.</mark>

**Output:** The result of the action will indicate if the note was successfully added.

### Create Ticket

<figure><img src="https://4222414448-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMAf5diEa8kgXDA6h47Cu%2Fuploads%2FxavaZnl23TZmJMvDCF1g%2Fimage.png?alt=media&#x26;token=ab713bd5-4036-4407-b081-f34e97357afe" alt=""><figcaption></figcaption></figure>

To create a new support ticket in Freshdesk, follow these steps:

**Description:** Creates a new support ticket in Freshdesk.

**Purpose:** To raise new support requests or issues.

**Usage:**

1. Select the "Create Ticket" action.
2. Fill in the required fields:
   * **Subject:** The subject line of the new ticket.
   * **Description:** Detailed information about the ticket.
   * **Requester Email:** Email address of the person raising the ticket.
   * **Status:** Current status of the ticket (e.g., Open, Pending).
   * **Priority:** Priority level of the ticket.
   * **Ticket Type:** Type of ticket being created.
   * **Source:** Channel from which the ticket originated.
   * **Due By:** Deadline for ticket resolution.
   * **Group ID:** ID of the support group handling the ticket.
   * **Product ID:** ID of the associated product.
3. Execute the action to create the new ticket in Freshdesk.

**Inputs:**

* **Subject:** <mark style="color:green;">The subject line of the new ticket.</mark>
* **Description:** <mark style="color:green;">Detailed information about the ticket.</mark>
* **Requester Email:** <mark style="color:green;">Email address of the person raising the ticket.</mark>
* **Status:** <mark style="color:green;">Current status of the ticket.</mark>
* **Priority:** <mark style="color:green;">Priority level of the ticket.</mark>
* **Ticket Type:** <mark style="color:green;">Type of ticket being created.</mark>
* **Source:** <mark style="color:green;">Channel from which the ticket originated.</mark>
* **Due By:** <mark style="color:green;">Deadline for ticket resolution.</mark>
* **Group ID:** <mark style="color:green;">ID of the support group.</mark>
* **Product ID:** <mark style="color:green;">ID of the associated product.</mark>

**Output:** The result of the action will indicate if the ticket was successfully created.

### Find User via E-mail

<figure><img src="https://4222414448-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMAf5diEa8kgXDA6h47Cu%2Fuploads%2FOXWw9jmsasTHG2P9xGkJ%2Fimage.png?alt=media&#x26;token=63dd2889-6bda-489e-957b-25c2fda37d69" alt=""><figcaption></figcaption></figure>

To locate a user within Freshdesk using their email address, follow these steps:

**Description:** Locates a user within Freshdesk using their email address.

**Purpose:** To search for and retrieve user details for ticket assignment or information.

**Usage:**

1. Choose the "Find User via E-mail" action.
2. Enter the Email Address of the user you want to locate.
3. Execute the action to search for and retrieve the user's details.

**Inputs:**

* **Email Address:** <mark style="color:green;">The email address of the user to locate.</mark>

**Output:** The result of the action will display the user's details if found.

### Get Attachment Contents

<figure><img src="https://4222414448-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMAf5diEa8kgXDA6h47Cu%2Fuploads%2Fz8E8djZQ3c4NVBrV2hOG%2Fimage.png?alt=media&#x26;token=d9757a4a-85bd-4917-9779-2b4cd4a6c288" alt=""><figcaption></figcaption></figure>

To retrieve the content of attachments from a ticket in Freshdesk, follow these steps:

**Description:** Retrieves the content of attachments from a ticket in Freshdesk.

**Purpose:** To access and view attachment files associated with a ticket.

**Usage:**

1. Use the "Get Attachment Contents" action.
2. Provide the Attachment IDs of the desired files.
3. Execute the action to retrieve the contents of the attachments.

**Inputs:**

* **Attachment IDs:** <mark style="color:green;">The identifiers of the attachments to retrieve.</mark>

**Output:** The result of the action will provide the contents of the attachments.

### Get Last Ticket Conversation

<figure><img src="https://4222414448-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMAf5diEa8kgXDA6h47Cu%2Fuploads%2FQU2or1mKu7QfSrPoPSxj%2Fimage.png?alt=media&#x26;token=4faef2c0-29da-4640-9428-75a3b678dfdc" alt=""><figcaption></figcaption></figure>

To fetch the details of the last conversation from a specific ticket in Freshdesk, follow these steps:

**Description:** Retrieves the details of the last conversation from a specified ticket.

**Purpose:** To view the most recent communication or updates on a ticket.

**Usage:**

1. Select the "Get Last Ticket Conversation" action.
2. Input the Ticket ID for the conversation you wish to retrieve.
3. Execute the action to fetch the details of the last conversation from the specified ticket.

**Inputs:**

* **Ticket ID:** <mark style="color:green;">The ID of the ticket for which to retrieve the last conversation.</mark>

**Output:** The result of the action will display the details of the last ticket conversation.

### **Upload Attachment to Ticket**

#### **Description and Purpose**

The **Freshdesk - Upload Attachment to Ticket** action allows Autom Mate users to upload files directly to a specific Freshdesk ticket. This action is essential for automating the process of attaching documents, images, or other files to tickets, which can be helpful in customer support workflows for providing additional context, troubleshooting information, or reports.

By selecting the appropriate **Ticket ID** and **Attachment Content**, users can seamlessly upload files to the ticket and store the response in a designated variable.

***

#### **Usage Instructions**

{% stepper %}
{% step %}
**Select App Credential**

**App Credential (Required):**\
Select the credential that enables the Freshdesk connector.\
Example:

```
Freshdesk Account
```

This credential ensures secure communication between Autom Mate and Freshdesk, allowing file uploads.
{% endstep %}

{% step %}
**Provide Ticket ID**

**Ticket ID (Required):** Specify the unique ID of the ticket to which the attachment should be uploaded.\
Example:

```
Copy12345
```

This field tells Autom Mate which Freshdesk ticket the files will be associated with.
{% endstep %}

{% step %}
**Provide Attachment Content**

**Attachment Content (Required):** Enter the attachment details in JSON format. Each file must have a `file_name` and `file_content` (base64-encoded string).

Example:

```json
[{"file_name":"sample.xlsx","file_content":"base64"},{"file_name":"icon.png","file_content":"base64"}]
```

* `file_name`: The name of the file (including the extension, e.g., `.xlsx`).
* `file_content`: The base64-encoded content of the file.
  {% endstep %}

{% step %}
**Assign Output Variable**

**Assign Output to Variable (Required):** Select an object-type variable (e.g., `UploadAttachmenttoTicket_output_ada5b143b16d4eada6a85c6e79cfd612`) to store the response from the Freshdesk API after the attachment is uploaded.
{% endstep %}

{% step %}
**Execute and Review**

Run the action. After execution, the attachment will be uploaded to the specified Freshdesk ticket, and the response will be stored in the assigned output variable.
{% endstep %}
{% endstepper %}

***

#### **Inputs**

<table><thead><tr><th width="248">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>App Credential</strong></td><td>Select the credential that connects Autom Mate to Freshdesk (e.g., <code>Freshdesk HERO</code>).</td></tr><tr><td><strong>Ticket ID</strong></td><td>Specify the Freshdesk ticket ID to attach files to (e.g., <code>12345</code>).</td></tr><tr><td><strong>Attachment Content</strong></td><td>Provide the list of attachments in JSON format, each with a <code>file_name</code> and <code>file_content</code> (base64-encoded).</td></tr></tbody></table>

***

#### **Outputs**

<table><thead><tr><th width="248">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>Upload Attachment Output</strong></td><td>Contains the response from Freshdesk after the attachment upload, typically containing status and metadata.</td></tr></tbody></table>

***

#### **Example**

* **App Credential**:

```
Freshdesk Account
```

* **Ticket ID**:

```
12345
```

* **Attachment Content**:

```json
[{"file_name":"sample.xlsx","file_content":"base64"},{"file_name":"icon.png","file_content":"base64"}]
```

* **Output Variable**:\
  The output variable will store the response from Freshdesk after the attachment is uploaded, containing metadata about the upload.

***

## Additional Tips

### [**Use Cases**](https://docs.autommate.com/userguide/use-cases)

### [FAQ](https://docs.autommate.com/userguide/faq)