API and Webhooks

Hello everyone! I’m new here and just getting started with development in Freshworks. Right now, I’m trying to create my first app. I’m attempting to get a list of agents via the API, but something is going wrong. I’m getting a console error about an unregistered function. Even though I’m doing everything according to the documentation. If anyone knows what might be the issue, please let me know. manifest.json{ "platform-version": "3.0", "modules": { "common": { "location": { "full_page_app": { "url": "index.html", "icon": "styles/images/icon.svg" } }, "requests": { "getAgents": {} } }, "support_ticket": {} }, "engines": { "node": "18.20.8", "fdk": "9.7.4" }, "app": { "tracking_id": "aixfa4rlutw791e3iubp" }}

I am attempting to set up a Webhook Freshdesk automation to PUT ticket data into my CRM. I need the company_ID in the data but cannot get anything to come through with the other fields.I have tried all of the following:{{ticket.contact.company_id}} {{ticket.contact.companyid}} {{ticket.company.id}}} {ticket.company_id}} {{company_id}} {{ticket.contact.department_id}}None of these returns any value at all. What is the correct tag for pushing the ID of the company?

Hi,Why is there no OpenAPI / Swagger YML specification file available for Freshworks APIs ?I tried both URLs below but did not work: https://MY-ACCOUNT.freshdesk.com/api/v2 https://MY-ACCOUNT.freshdesk.com/api/v2/swagger.yml I guess you would agree that OpenAPI is a standard among software APIs and would make life so much easier for Postman tests and API access code generation.And would be a really nice companion for the already nice Freshworks products :-)Thanks

If there a way to use a widget so the widget is always open and embedded in the middle of the webpageI would like it to be always open as it is on this website https://www.directline.com/car-cover/contact-usI can only place it bottom left/bottom right with a help buttonIf I try and use an iframe, it no longer appears bottom left or right, but the content does not load. 

Hi everyone! I would like to ask for some help.I have the task of integrating FreshDesk with Power BI. Here in the forum I found some steps, but I still have doubts and need help to move forward with this demand.I would like to know if there is a step-by-step tutorial for beginners on how to do this integration. From scratch! Because nothing like this has ever been done in my environment. I have already done this configuration: and now I need the steps to proceed with the integration. Can you help me? I would be very grateful! Best regards.

I’m making requests to bring ticket data and I’ve included the stats. However, I noticed that in some requests the first_responded_at field has a date before created_atExample: "created_at": "2025-08-04T21:17:28Z",        "updated_at": "2025-08-29T14:40:53Z",        "associated_tickets_count": null,        "tags": [            "PROD02221-594"        ],        "stats": {            "agent_responded_at": "2025-08-06T20:43:38Z",            "requester_responded_at": "2025-08-06T19:47:42Z",            "first_responded_at": "2024-12-02T21:53:47Z",            "status_updated_at": "2025-08-11T15:30:51Z",            "reopened_at": null,            "resolved_at": null,            "closed_at": null,            "pending_since": null What could be causing this?

I am using the Freshservice API, and I made a change. I now want to submit the change for approval, but not against 1 person. It is more like a group of people. In the Web Interface, I would normally click “Request for approval”, then click “CAB Approval” and then select say “Canada - CAB”. Then a list of 5 people appears with checkbox. I want to keep them all checked, but change the type to “anyone can approve”.The endpoint I have for making approvals is “/api/v2/ticket/1448/approvals”, and json object body is {  "approval_type": 2}but I keep getting 404. Also I have no idea how to set up the body json for my specific request. Does anyone know? Thanks 

Hello Freshdesk Support Team, We are experiencing a limitation with the Freshdesk API v2 that is impacting our integration and reporting capabilities. Issue Summary: We cannot access thread conversations (Private Threads, Forward Threads, Discussion Threads) that exist within ticket notes via the API, even though these threads are visible and functional in the Freshdesk web interface. Current Situation:  What Works:  We can successfully retrieve main conversations using: GET /api/v2/tickets/[id]/conversations We can see private notes and public notes - The web interface shows all threads correctly  What's Missing: Thread conversations nested within notes are not returned by the conversations endpoint - Multiple replies within a Private Thread appear as a single note in the API response We lose the thread hierarchy and individual messages

Hi,I’ve created a feedback widget.I’ve added the related code to the footer connecting a button with a JS listener and it’s correctly opening a ticket.I’ve tried to pre-fill the most of the filed ( native and custom ) following the documentation:https://developers.freshdesk.com/widget-api/But the filed are not auto filled.I’m sharing the code, could you please confirm that the structure in correct ( we can asume that the maping is correct ) : <script>  window.fwSettings = {    'widget_id': 103000008811  };  !function(){if("function"!=typeof window.FreshworksWidget){var n=function(){n.q.push(arguments)};n.q=[],window.FreshworksWidget=n}}();</script><script type='text/javascript' src='https://euc-widget.freshworks.com/widgets/103000008811.js' async defer></script>

Hi there,Just a question to create a discussion: we are looking for an tool to easily create API Documentation. We are very impressed by the way the Freshdesk API is documented. Does someone know which tool Freshworks uses to create these API documentations pages? If not, any other experiences with great tools to create API documentation?https://developers.freshdesk.com/Kind regardsJos van den End

I am trying to gather specific information on our Freshdesk tickets via API. It seems there is no way to actually get the activities (such as closed via a scenario automation rule) of a ticket via API unless you create a report and export it (Example: https://support.freshdesk.com/en/support/solutions/articles/226460-export-ticket-activities-from-your-helpdesk). This will not work for my needs. However, I feel like certain fields could be useful for our reporting needs, such as Closed By or Resolved/Closed Reason (per agent, automation, per customer, etc…). Unless I’m missing something in the API documentation, I’m not seeing any fields similar to these as part of the ticket API. I know I can get Resolved At and Closed At by using “/api/v2/tickets?include=stats”, but that only includes dates and not who cl

Hi,I realize this question is better posted to the FreshservicePS Slack channel, but I haven’t received a response in that forum so I’m trying my luck here.I’m using the FreshservicePS PowerShell module and have a question regarding the data retrieved with Get-FreshServiceTicket. I have a ticket that was created from a Service Catalog form, and when I view the SR in the WebUI the form data is visible but it is not retrieved with Get-FreshServiceTicket.How do I retrieve this data using powershell or via the API directly?Thanks!

When I attempt to create a solution article from URL using the Article creation API, I get the following errors:  "description": "Validation failed",    "errors": [        {            "field": "title",            "message": "This field cannot be empty",            "code": "missing_field"        },        {            "field": "description",            "message": "This field cannot be empty",            "code": "missing_field"        },        {            "field": "folder_id",            "message": "This field cannot be empty",            "code": "missing_field"        },        {            "field": "status",            "message": "This field cannot be empty",            "code": "missing_field"

Hi everyone, We are an OTA (Online Travel Agency) and we use FRESHDESK, FRESHCHAT and soon what used to be called FRESHCALLER. At the time this message is being written, we have different channels through which tickets are created. The main ones are Freddy the CHATBOT or via incoming EMAILS.CHABOT : We gather a LOT of data from the clients booking (booking date, traveling date, insurance etc.) and we structurally push this information via the CREATE TICKET verb of the FRESHDESK API at the end of the CHATBOT CONVERSATION. As a result, the custom fields are filled in and we are able to calculate PRIORITIES (via the AUTOMATION RULES) based on these fields.    EMAILS : Here the situation is a bit more difficult. Let me try to summarize what happens : One of our system (outside of FRESHDES

Hello,We’re using Faraday + s3 links provided by the Freshdesk API when fetching tickets.  We’re able to download ticket attachments but are not sure what format they’re in when they arrive.We need to be able to encode/decode these ticket attachments and save them to our own s3 instance.  These will be PDFs exclusively. Is this something we need to change in the Faraday settings?

How to create webhook for contact creation/update using rest apis 

I have a webhook runbook set up on a hybrid worker in Azure that is written in PowerShell 5.1. When the runbook is triggered, the webhookdata object that is delivered is null. Below is the simple test script I’ve created as a starting point using an example from Microsoft documentation.When it runs, the WebHookData object that is delivered by the webhook is null. param (    [Parameter (Mandatory = $false)]    [object] $WebHookData    )if ($WebHookData) {    write-information $WebHookData    if (-not $WebHookData.RequestBody) {        $WebHookData = (Convertfrom-Json -inputobject $WebHookData)        write-information $WebHookData        }    $WebHookData | set-content -path "<some path>" -force    $VMS = (convertfrom-json -inputobject $WebHookData.RequestBody)    write-information $VMS    }else {    write-information "WebHookData is null"    }

🙏Mods, please move this ticket if I didn’t put it in the right place!  Thanks!Based on the API documentation found here: https://api.freshservice.com/#create_child_service_requestNote 1:Association of child Service Request to a deleted or a spammed ticket is not allowed.Note 2:Nesting of a child Service Request under another child Service Request is not supported. I should be able to use this endpoint, passing in a parent ticket id of a Resolved ticket.  But doing so results in the following error: "code":"invalid_id","message":"There is no record matching the id: 1337" Please either update your documentation or change this behavior.SOLUTION: The way I got around the issue is by reopening the parent ticke

In my FreshService Sandbox that I am working in trying to do some automation we have some fields as shown in the pic I want to be able to download these attachments, but I cannot find a way through the API to access these, These are attached when the ticket is created and need to be in these specific fields.I can access the text in the field without issue, via API, but not the attachments. Is there even a way to do this via the API? I have tried everything I can think of without success.

Adding this to this particluar forum even though this is for Freshservice and not Freshdesk.  There doesn’t appear to be an API subforum for API in Freshservice?But anyway, I’m trying to update old tickets with summarized resolutions notes via API (yes, without Freddy) but haven’t had any success.  Has anyone had luck using API to update Resolution Notes in a ticket?  In Freshservice’ defense I don’t see any documentation about using the API in this way.  But I was hoping it’d be a simple matter of generating a body/json that looks like: {     “ticket”: {           “resolution_notes” : In order to fix this we had to use this 3 step guide”,           “resolution_notes_html” : <div dir="ltr">In order to fix this, we had to use this 3 step guide."</div>     }}The error I’m getting back indicates that it’s not an expected field saying “Validadtion failed” and listing the “resolution_not

   When using the following endpoint, pagination works> Invoke-RestMethod -Method GET -Headers $headers -Uri ($uri + "/tickets?$fsUpdatedSince&per_page=100&include=stats,tags") -ResponseHeadersVariable 'ticketsResponseHeader'> $ticketsResponseHeaderKey                             Value---                             -----Date                            {Tue, 08 Jul 2025 05:43:06 GMT}Transfer-Encoding               {chunked}Connection                      {keep-alive}status                          {200 OK}x-freshservice-api-version      {latest=v2; requested=v2}Link                            {<https://xxxxxxxx.freshservice.com/api/v2/tickets?updated_since=2025-06-01T10:40:21Z&per_page=100&include=stats,tags&page=2>; rel="next"} However when using the /tickets/filter endpoint, the responseheader does not incl

Hello,We as a company have only recently started using Freshdesk following leaving an old ITSM solution. I can’t see anyone has mentioned this in the forums or from searches online so I thought I’d message here.We support a large number of schools for their IT issues, teachers are generally always teaching and they will say to us to contact them at say 12pm on Wednesday.In our old ITSM we could put the ticket on hold/pending and set it to open on a specific date/time by setting this in a field, the ticket would then change to an open state once that specific date/time is reached.I can’t see any way to do this in Freshdesk. I know you can use the To-Do list feature to set a reminder but this doesn’t take the ticket from a Pending state to an Open state, it just sits as Pending requiring the assigned user to set it as Open themselves. Is there a way for the To-Do list to automate this to set as Open? If this was possible then that would be a really good sol

We’re using Zapier API calls to get the requester name and email address from the user ID, but when the object is returned everything is correct except for the email address it returns. The address has the domain removed and a :censored:xx:xxxxxx.com address. The receiving service will not take that format as a valid email address. Why is this being returned incorrectly and is there a setting in FS that can change this?