--- title: Freshdesk CRM App creation and Installation Guide slug: contact-center/freshdesk-crm-app-creation-and-installation-guide docTags: createdAt: 2025-10-23T09:52:51.631Z --- # Overview This document serves as a guide for the users to carry out the confguration (application for release 4.7 and above) at the Freshdesk CRM end. The step wise guide is as follows: # Usage Instructions ## Step 1: Create Freshdesk Admin Account 1. **Sign Up:** Go to `https://freshdesk.com/signup`, provide the required details and sign up. 2. **Verify Account**: Check your email for a verification link to activate your account. 3. **Get API Key**: Navigate to your profile settings in Freshdesk and copy your API key. This key is required for the app configuration. ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/dhKM-rmKuC9_O12vwOaFa_.blob) ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/w2n5PRaxVYifYlR3CTKcK_.blob) ## Step 2: Upload a custom app on Freshdesk The integration is enabled by uploading a custom Ameyo application to your Freshdesk account. Go to `https://(your freshdesk domain).freshdesk.com/a/integrations/applications/#custom_apps` or follow the following steps. 1. **Navigate to Apps**: In your Freshdesk account, go to **Settings** and select **Apps**. *** ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/GCgn7pGtWVmr3AnopTrgU_.blob) 2. **Go to Custom Apps**: Click on the **Custom Apps** tab. ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/VVqcJ-WofuXijXk9MzcUP_.blob) 3. **Select the "New Custom App" option.** ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/qX4Wowka1Xhj0k8opF5j__.blob) 4. **Upload App:** - Click the **New Custom App** button. - You will be redirected to the Freshworks Developer portal. Here, select **+Add New App**. ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/cd5wuutdjvpvyaq1C-INB-20260729-054405.png) - Choose **Custom App**. - Upload the `freshdesk.zip `app file and fill in the required details, such as App Name and Support Email. *** ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/LmB-vYW321ddtB2NZiDhP-20260729-054409.png) ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/FvyrkfmtWyXQFk4oPfvpb-20260729-054408.png) ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/06UwxKJh-ShcSOyz-r2Pp-20260729-054409.png) *** 5. **Publish and Install**: - After uploading, select **Publish**. ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/QuzpcAFFcVsyPVIUXv9bw-20260729-054416.png) - The app gets published after 5 to 10 minutes. Once published, you can find the app on the .customapp page of freshdesk or go to `https://(your freshdesk domain).freshdesk.com/a/integrations/applications/#custom_apps` ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/ORh8MQYHfskxljX_GSLUL-20260729-054410.png) - Return to the **Custom Apps** page in Freshdesk and click **Get Custom Apps**. - Find your newly published Ameyo app and click **Install**. *** ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/E1fhDXPrcXTzdwRKLutL9-20260729-054413.png) - **Click on the "Install" button.** ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/8LPnbqW-r_zuASItZz-OG-20260729-054415.png) *** 6. **Configure the App**: - During installation, you will be prompted to enter the **Ameyo server domain** (e.g., `https://mycompany.ameyo.com:8443`). - Enter your Freshdesk **API key** in the format `:X` - Provide your Freshdesk domain without `https://` - Click **Save**. *** ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/_7_G1g3a6G3nGrv1puKO6-20260729-054413.png) *** 7. **Verify Installation**: Reload your browser. The Ameyo toolbar icon will appear on the left-side panel of your Freshdesk dashboard. Clicking this icon opens the Ameyo login toolbar. - Now, your app is listed. The green toggle button shows that the app is enabled. ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/HECfdfmVhTO72EQzjmjTY-20260729-054414.png) *** - Reload your browser tab. Ameyo toolbar icon is displayed on the left-side panel on the Freshdesk dashboard. ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/9_nkRpUwLCOADvaYVWy7Z-20260729-054406.png) *** - Click on the logo to open the Ameyo toolbar. ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/aWXDoJ-vMSVmbsAd7gCr9-20260729-054407.png) ## Step 3: Create custom field on Freshdesk To properly log call outcomes, you must create custom fields in Freshdesk to store disposition data from Ameyo. - **Navigate to Ticket Fields**: Go to **Settings** and select **Ticket Fields**. - **Create Text Fields**: Add new single-line text fields to your ticket form. - **Recommended Setup**: - For a **two-level disposition** structure, create two fields with the labels **Disposition** and **Sub-Disposition**. - For a **single-level disposition**, create one field labeled **Sub-Disposition**. *** ***Step wise guide is provided below:*** 1. **Go to settings.** ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/HNRex7j9Z8siUeRRfg2gO-20260729-054417.png) 2. **Go to Ticket Fields.** ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/8vqmE1KphqGUaOa0i-bVL-20260729-054418.png) ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/7yR4VfXVGG3nFJByTKS1R-20260729-054419.png) 3. **As shown below, dispositions and sub-dispositions are created as simple text boxes.** ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/0oqpWFf9kre8pQxprKvXz-20260729-054411.png) *** 4. **Click on "Done".** ![](https://api.archbee.com/api/optimize/SK2urIgCC2ml99YyqWOSl/QZ6ShI5C_WDnSYEHVZIf3-20260729-054412.png) 5. **Below is the recommended way of creating custom fields.** - For two-level disposition - Disposition - Label: Disposition - Sub Disposition - Label: Sub-Disposition - For one-level disposition - Sub Disposition - Label: Sub-Disposition :::hint{type="info"} After executing the steps mentioned in this document, there will be few configurations done at the Ameyo DB as well, for which the details will be provided by the designated project manager/engineer :::