Customer support
Freshdesk in your product and your AI agents, through one API
The Freshdesk toolkit covers tickets and their conversations, ticket fields, contacts and company search. Your product or AI agent calls them through Connect, which stores the customer's credentials and logs every execution, so you skip building the integration.
15 days to try it. No credit card.
POST https://connect.reportei.com/api/tools/freshdesk_create_ticket/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"requester_id": 1
}
}How it works
From a connected customer to the first Freshdesk call.
- 1
Your customer connects the account
Your system opens a Connect session for the toolkit and your customer connects their Freshdesk account. You get the connection id.
- 2
Your product calls the tool
A POST to /api/tools/{tool}/execute with the connection id and arguments. On success, Connect preserves the app's response status and body.
- 3
Connect handles the rest
It stores the credential encrypted, renews tokens for OAuth connections that support renewal and records executions in an audit trail available through the API.
Use cases
What your product does with Freshdesk.
Open tickets from your product
A SaaS creates a Freshdesk ticket when a user reports a problem, identifying the requester by email so a new contact is created if needed.
Support copilot for agents
An AI agent searches tickets by status or priority, reads the conversation and posts a private note or a reply to the requester.
Keep contacts in sync
A CRM or billing tool creates and updates Freshdesk contacts and links them to companies found by name.
Tools
13 Freshdesk tools
- List ticketsGETLists tickets, newest first by default. Without updated_since only tickets created in the last 30 days come back, and spam or deleted tickets only come with filter. Pages are numbered from 1, up to page 300; a page with fewer tickets than per_page is the last one.
- Search ticketsGETSearches tickets with a filter query, for example by status, priority, agent, group, tag or a custom field. Returns total and results, 30 tickets per page, up to page 10. Archived tickets are left out, and changes take a few minutes to show up.
- Get ticketGETReturns one ticket with its status, priority, requester_id, responder_id, group_id, tags, custom_fields and description. The requester email, company name and conversations only come through include.
- Create ticketPOSTCreates a ticket. Identify the requester with requester_id, email, phone or unique_external_id; an email or phone not yet in Freshdesk creates the contact. Fields marked required_for_agents in List ticket fields must be sent too, or Freshdesk refuses the ticket.
- Update ticketPUTUpdates a ticket: send only the fields to change, and tags as the full list the ticket should keep. Status 4 resolves and 5 closes it, and closing needs the fields marked required_for_closure in List ticket fields. Spam or deleted tickets return 405, and outbound tickets keep their subject and description.
- List ticket conversationsGETLists the replies and notes of a ticket, with body (HTML), body_text, private, incoming, user_id and source (0 reply, 2 note). Pages are numbered from 1; a page with fewer items than per_page is the last one.
- Create ticket replyPOSTReplies to the requester of a ticket. Freshdesk emails the reply to the requester, so it is visible to the customer. Tickets from web chat or the mobile SDK take structured content instead of body, which this tool does not send.
- Create ticket notePOSTAdds a note to a ticket. Notes are private by default, visible only to agents; with private false the requester can see it too.
- List ticket fieldsGETLists the ticket fields of the helpdesk with their choices: agent ids in the agent field, group ids in the group field, product ids, status values including custom ones, ticket types, and the name of each custom field, which is its key in custom_fields. required_for_agents and required_for_closure mark the fields create, update and closing need.
- List contactsGETLists contacts, the customers who raise tickets, with id, name, email, phone, mobile, company_id, tags and custom_fields. Filters combine, and only unblocked and undeleted contacts come by default. Pages are numbered from 1; a page with fewer contacts than per_page is the last one.
Username and password
Your customer enters the app credentials on a Connect screen, or your system sends them with POST /api/customer-toolkits, with no screen.
When connecting, your customer also enters {domain}: the address of their account on the app's API.
Questions about the Freshdesk toolkit
Do I need to build against the Freshdesk API?
No. Connect ships 13 Freshdesk tools, described and ready. Your customer connects the account and your system calls every tool through the same endpoint, with the same request format.
How does my customer connect their Freshdesk account?
With the mode the toolkit accepts: Username and password. Connect stores the credential encrypted and never returns it to your system.
Does it work with AI agents?
Yes. Each tool's input is described in JSON Schema, which your agent uses directly as a tool definition. The agent picks the tool and the arguments, and your system makes the call to Connect.
Does my customer need a Reportei account?
No. Your customer connects the account on a Connect screen, or your system sends the credential through the API, and they keep using only your product.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
