Skip to main content
  • EN

API and Webhooks

Using Freshdesk

  • 240 Posts
  • 513 Replies
240 Posts
S
Community Manager
Sumana SrikanthanCommunity Manager
posted in API and Webhooks
Set up Custom Objects in your Freshdesk yet?

Applicable plans: Forest/Enterprise You can create Custom Objects to capture all relevant, business-critical information right from the get-go with just a few clicks. Through these Custom Objects, you can equip your agents with complete context and enable them to be productive, and respond and resolve faster than ever.  If you are on the Forest or Enterprise plan, just drop a comment on this post to learn more!

89010
Tintin
Skilled Expert
rhea.desouza
Community Manager
rhea.desouzaCommunity Manager
published in API and Webhooks
Ask me Anything: Live Q&A on API's and Custom ObjectLIVE Q&A

Did we save the best for the last day of November? Let’s find out.@sukanya.arunachalam, Customer Success Engineer, Freshworks, is all set to take the stage at a special ‘Ask Me Anything’.  A little note about our host 💎I got lucky to start and continue my career with a customer-facing job in an expeditiously growing company with over 8 plus years of experience. Starting as a Support Engineer really helped me to shape myself to have a "Customer First" attitude and to become this ardent customer experience representative.Having gained some technical exposure on how SaaS-based products function and have found some success in the areas of Implementation, customer support, framing/coordinating processes, and coaching analysts, I am working on understanding the workflow model of different businesses across SaaS to help offer recommendations which in turn would help deliver better ROI and improve our customers KPI’s! 🎥 Topic: 1. API’s: Overview and capabilities 2. Custom Objects💡 You will

57312
Umar Akbar
Contributor
Pozole1300
Apprentice
Pozole1300Apprentice
asked in API and Webhooks
connection problems

Buen día,Tengo problemas de conexión con mis cuentas de Freshdesk y Freshchat. No consigo que funcionen correctamente ni sincronizar mis contactos.Ya me he puesto en contacto con otro soporte, pero ninguna de las soluciones ofrecidas ha sido funcional.Quedo atento a vuestro apoyo.Atentamente.

253
Pozole1300
Apprentice
C
cpv
asked in API and Webhooks
Validated json string gets error creating ticket

We are using https://www.toptal.com/developers/json-formatter to test validate our strings from our logs into json strings for creating a ticket.We had a verified json string, but an error when creating the ticket.  The ticket works sending just “123”Any ideas? { "description": "<pre>***************************************************************************************************<br>QQube Synchronizer - Starting Time: 06/22/2024 12:05:28 PM - Setup Wizard<br>Application Version 10.1</pre>", "subject": "Log file from #0 Demo User Success 6/22/2024 12:05:28 PM Full", "email": "matt@clearify.com", "priority": 1, "status": 1 }

302
jparse
Community Debut
rfordmail
Apprentice
rfordmailApprentice
asked in API and Webhooks
API end point for requested items

I have an API which successfully extracts all FreshService tickets and inserts them into a SQL database table.I now need an extra column which is located on requested_items. I tried to access this data with an API call for each ticket. This worked but blew out the daily maximum API calls when I tried to process thousands of tickets.api/v2/tickets/'+str(row["id"])+'/requested_itemsSo I am now trying to extract all requested_items for a time period and insert then in a SQL database table. Later, in the reporting layer, these tables can be joined to show all requested_items for a set of tickets.Can you please tell me how to code the API to extract all requested_items for a time period?Does this endpoint exist?something like : api/v2/requested_items    ??

313
rfordmail
Apprentice
M
Contributor
milad2004Contributor
asked in API and Webhooks
400 Error invalid field for custom field

Google Script app codefunction createTicket(e) { var API_KEY='My API '; var ENDPOINT = 'My domain'; // change to https if SSL is configured. var headers = { 'Content-type': 'application/json', 'Authorization': 'Basic ' + Utilities.base64Encode(API_KEY + ':X') }; var payload = JSON.stringify({"description":"Help needed desparately","subject":"Testing API","email":"user@test.com","priority":1,"status": 2 ,/*I did try this didn't work either*/// 'custom_field[cf_campus]':'QLD'"custom_field": { "cf_campus": "QLD" }}) var url = ENDPOINT + '/api/v2/tickets'; var options = { 'method': 'post', 'headers': headers, 'payload': payload, muteHttpExceptions: true }; // Logger.log("url: " + url); Logger.log("payload: " + options.payload); Logger.log("headers: " + options.headers); var response = UrlFetchApp.fetch(url, options); Logger.log("code: " + response.getResponseCode()); Logger.log("text: " + response.getContentText());}/* Getting this error in outputco

51
M
Contributor
C
Apprentice
ccheeverApprentice
asked in API and Webhooks
Freshservice intergration with on-prem Endpoint Central

, none of the related Topics are remotely close to my question,I am setting up Freshservice integration with on-prem Endpoint Central. When I test the connection, I only get errors. I added the IPs that Freshservice's “Support” provided, and it still fails. FYI none of the related Topics are remotely close to my question so I am just picking one.

40
C
Apprentice
Tintin
Skilled Expert
TintinSkilled Expert
asked in API and Webhooks
API Freshdesk to Power BI

Hi,How can I retrieve data from Freshdesk via API for the date range from January 1, 2024 and for the specific group, to the current date?Thank you,Tin

704
T
Community Debut
panksi
Apprentice
panksiApprentice
asked in API and Webhooks
generateTargetUrl() generates url that is common for whole space

as said in the title,The hook url that was generated for me was baseurl//event/hook/freshdesk for example.How do external events work then, is this hook tied to the space or to the each installation?will it fire 35 times if 35 agents use the app?

283
mahendarsingh
Community Manager
N
Apprentice
Nicklas LyngsoeApprentice
asked in API and Webhooks
Proposal: Ability to Change Webhook Failure Notification Email

Idea:I propose adding a functionality to allow users to change the email address where webhook failure notifications are sent.Reasoning:Currently, webhook failure notifications are sent to the account holder's email by default. However, in many cases, the account holder is not actively involved in monitoring or managing technical issues. They often do not interact with our ticketing system, leaving webhook failures unnoticed or delayed in resolution.Solution:Introduce an option within the system settingsCustomize the notification email to a preferred address, such as a system administrator or IT team email. Ensure that these changes can be easily updated by authorized users.Benefits:Faster detection and resolution of webhook failures. Ensures notifications reach the correct technical personnel. Improves system reliability and customer satisfaction.I believe this feature will add value for customers with dedicated technical teams managing integrations and reduce unnecessary involvement

202
mahendarsingh
Community Manager
andrewcruzr
Apprentice
andrewcruzrApprentice
asked in API and Webhooks
Could'n get tickets using per_page

Hello! I need to use pagination to get all open tickets from freshdesk, but it’s not working as expected when i try to use “per_page”:api/v2/search/tickets?query="status:2" works fine, but don’t retrieve all results If i use the “page” parameter, it work fine too. api/v2/search/tickets?query="status:2"&page=2 But if i try to use “per_page” parameter it doesn’t work. api/v2/search/tickets?query="status:2"&per_page=2 Can someone help me figuring out what i’m missing? Thanks  

6273
l1ll1
Community Debut
estanicy
Apprentice
estanicyApprentice
asked in API and Webhooks
Retrieve historical Ticket data

Hello,I am having trouble retrieving historical ticket data, we have a lot of tickets that need to be retrieved for the whole 2024, but i am stuck in how to retrieve all of them. I have tried filtering and also using a “target_date” and a descending order from the latest ticket to the target date but i always get an error (mostly from reaching over the 300 pagination limit). I am trying this in python, can anyone help me on how to build a proper request for this? Thanks

1003
fatimasmak
Community Debut
R
Apprentice
rowebApprentice
asked in API and Webhooks
Freshdesk webhook to set subject line

I am trying to create a webhook to set the subject line of tickets raised via the Freshdesk portal. I have read and followed the instructions from various Freshworks pages and community articles, and no matter what I do, I cannot get this webhook to work!I can see that the automation has run on all of the test tickets that I have raised - but the subject lines aren’t actually changing! Is anyone able to help with what I am doing wrong? Please note that in the screenshots below I have replaced the URL and API key with placeholders for security reasons, but rest assured that these are entered correctly in the automation!  

423
flaresolverr
Community Debut
Y
Apprentice
ygor.silvaApprentice
asked in API and Webhooks
Help with APO

Hello, how are you guys ? I have a question, anybody already use API to disable users in freshdesk administration ? I need to creat a automation to deactivate and create users in freshdesk admin control, but i can’t find any documentation for this action

151
Sujitha Dhanaseelan
Community Manager
JBH ABCIS
Apprentice
JBH ABCISApprentice
asked in API and Webhooks
"List All Tickets" API, filtered by Group or View?

Hi. We’re trying to pull ticket data into our reporting/insights platform.The main idea is to start with a simple last-updated date filter (e.g. 2024-12-01), then paginate as much as we can, then change the filter (e.g. 2024-12-01T15:30) to narrow the date range and collect a new set of pages.I have two problems:We have a ticket type for automated logging, which tends to be the vast majority of tickets. I don’t need to report on this, but it adds a lot of noise if I use the “v2/tickets” endpoint, because I can’t filter it by type. Outside of automated logging, our ticket volume can be over 300 tickets per day, and “v2/search/tickets” can’t filter updated-at by timestamp, only by date. There’s no way to use that endpoint for this pagination approach.So I can’t have both type-filtering and timestamp-filtering in the same endpoint. Right now, I’m just using the “v2/tickets” endpoint and discarding anything for the unwanted type, but this still results in a lot of unneeded API calls. We co

803
JBH ABCIS
Apprentice
Tintin
Skilled Expert
TintinSkilled Expert
asked in API and Webhooks
API Freshdesk

Hi, How can I retrieve data within the specific group from Freshdesk via API for the date range from January 1, 2024, and to the current date?  We need to integrate this in Power BI tool. Thank you,

543
madhusingh0906
Community Manager
Tintin
Skilled Expert
TintinSkilled Expert
asked in API and Webhooks
Freshdesk Fields

Hi, What is the limit of fields in freshdesk? thank you

591
madhusingh0906
Community Manager
Tintin
Skilled Expert
TintinSkilled Expert
asked in API and Webhooks
Freshdesk Integration

Hi, How to integrate other ticketing tools in freshdesk?Example: Service now, etc., Thank you,

251
madhusingh0906
Community Manager
T
Apprentice
TamilarasiApprentice
posted in API and Webhooks
Issue with Retrieving Email Field in Contact Search API Response

I'm facing an issue with the Contact Search API. When I call the API to search for contacts, the response includes fields like phone, ID, and name, but the email field is missing from the results.Has anyone encountered this issue before? Are there any specific settings or permissions required to retrieve the email field? 

422
furqan85
Community Debut
N
Apprentice
NicoleKinApprentice
asked in API and Webhooks
Webhook to GET email attachments using JSON

Hello!So, I wanted to be able to use the webhook function to extract attachments from tickets automatically after a desired trigger action and either save them to a dedicated file destination or send the data to an application to immediately print pdf/xlxs files. I’ve been reading the documentation, but I think the “Using Webhooks” article might be outdated and would appreciate some help to make sure it works as intended. As I understand it, the JSON code would look something like this:{ "name": "Fetch Email Attachments", "url": "https://yourserver.com/webhook-handler", "http_method": "GET", "headers": { "Content-Type": "application/json", "Authorization": "Basic YOUR_BASE64_ENCODED_API_KEY" }, "payload": { "ticket_id": "{{ticket.id}}", "event": "{{event}}" }, "trigger_on": [ "ticket.created", "ticket.updated" ]} However, in the Trigger webhook section I don’t have an option to edit the body, so I can only assume that the website already has the function writ

1161
Sneha Kandasamy
Community Manager
A
Community Debut
averdier.solarhonaCommunity Debut
asked in API and Webhooks
Freshdesk SSO SAML Azure AD

Hi everyone, I have a problem when i create a SSO SAML between Freshworks and Azure AD.I make all the parameter with the tutorial but i have an error when i try to connect with SSO.Look at that :If anyone have an idea ?Or something to try ?Thanks a lot :)Alexandre

1016
A
Community Debut
D
Contributor
DcurtContributor
asked in API and Webhooks
View Solution Folder

How am I supposed to make an API call to view a list of subfolders? To view list of a Solution Folder you have to put in the category as a param…/api/v2/solutions/folders?category_id={id}

733
F
Community Debut
KingKEN
Apprentice
KingKENApprentice
asked in API and Webhooks
Horrible Freshdesk APIs to retrieve past tickets

Using: /api/v2/search/tickets?query=[query]:The official FreshDesk docs provide this limitation: "The number of objects returned per page is 30; also, the total count of the results will be returned along with the result" and "To scroll through the pages, add page parameter to the URL. The page number starts with 1 and should not exceed 10." This implies that I can only account for a maximum of 300 objects (tickets). What if I have more than 300 objects to account for in a specified interval, say within an hour?The ‘created_at’ parameter is strictly a date datatype (YYYY-MM-DD), so I cannot partition the data according to hours, which would otherwise have been a solution that circumvents the pagination limitation. Using: /api/v2/tickets?:Another significant limitation is the ‘updated_since’ parameter. It only applies to tickets that have been updated at least once during their lifespan. Tickets that are not updated will not appear in the API response, further restricting the data that

1143
Sujitha Dhanaseelan
Community Manager
M
Community Debut
MohamedFazil01Community Debut
asked in API and Webhooks
Tickets not found in TimeEntries

Hi all,I’m new to freshdesk APIs and sorry if my question doesn’t make any sense.I’m working on powerBI with freshdesk API to do some analysis. I’m in need of Tickets and Time_Entries data which I requested through the API endpoins.I have noticed some of the tickets are not found as entries in “time_entries” data.for instance, take a ticket with id “6364” in “tickets” data and when I match that ticket to the time entries under “ticket_id” column I couldn’t find a entry for some tickets.Initially I thought if there is no responder then no time entries will be found. But I saw some tickets with no responder in time entries.Am I missing something here? Any help is appreciated. Thanks for the time.RegardsFazil M 

524
M
Community Debut
A
Community Debut
AndiWCommunity Debut
asked in API and Webhooks
Freshdesk API performance optimation

Hello,I use the freshdesk API to synchronize contacts and companies with our internal systems.Therefore i have to read all 23.000 contacts, which takes a lot of time. Using pagesize=100 single threaded it takes over 20 minutes. With parallelization using 50 parallel threads, it only takes 10 minutes to get all of them. Now I have two questions:What is the best configuration for parallelization in this context?And is it possible to reduce the data volume by only getting the needed fields (I tested the ?fields parameter, but it doesn’t work)?Many thanksAndiW

232
A
Community Debut

Badge winners

  • Wizard of Creative Thinking (5)
    Ulfrohas earned the badge Wizard of Creative Thinking (5)
  • Lightning (Mc)Learner
    lsommerhas earned the badge Lightning (Mc)Learner
  • Salud, Ideator
    Kevin Adamshas earned the badge Salud, Ideator
  • Lightning (Mc)Learner
    k.robertshas earned the badge Lightning (Mc)Learner
  • Salud, Ideator
    Corey.Ghas earned the badge Salud, Ideator
Show all badges
Terms of Use