El catálogo/Freshdesk
Freshdesk
app.freshdesk
Freshdesk customer support — manage tickets, contacts, agents, companies, and ticket fields.
Versión2.0.0
Categoríasupport
AutenticaciónClave de API
Herramientas18
Transportestdio
LicenciaMIT
02
Herramientas
18 herramientas que el agente puede llamar.
Todas se declaran con parámetros tipados y devuelven resultados estructurados, así que el anfitrión puede renderizarlas en vez de narrarlas.
- add-note-to-ticketAdd a note to a Freshdesk ticket (POST /api/v2/tickets/{ticketId}/notes). Requires body (HTML content). Notes are private by default (visible only to agents). Set private=false to make it public. Returns the created note.
- create-companyCreate a new Freshdesk company (POST /api/v2/companies). Requires name. Optionally provide domains (array of domain strings), description, and note. Returns the created company.
- create-contactCreate a new Freshdesk contact (POST /api/v2/contacts). Requires name. Optionally provide email, phone, mobile, and other fields. Returns the created contact.
- create-ticketCreate a new Freshdesk support ticket (POST /api/v2/tickets). Requires subject, description, and email. Optionally set priority (1=low, 2=medium, 3=high, 4=urgent) and status (2=open, 3=pending, 4=resolved, 5=closed). Returns the created ticket.
- delete-ticketDelete a Freshdesk support ticket by its ID (DELETE /api/v2/tickets/{ticketId}). This permanently removes the ticket. Returns a success confirmation.
- get-companyGet detailed information about a specific Freshdesk company by its ID (GET /api/v2/companies/{companyId}). Returns name, domains, description, note, and other company fields.
- get-contactGet detailed information about a specific Freshdesk contact by their ID (GET /api/v2/contacts/{contactId}). Returns name, email, phone, company, and other profile fields.
- get-ticketGet detailed information about a specific Freshdesk support ticket by its ID (GET /api/v2/tickets/{ticketId}). Returns subject, description, status, priority, requester, agent, timestamps, and custom fields.
- list-agentsList Freshdesk agents / support staff (GET /api/v2/agents). Optional filters: email, page, per_page. Returns agent id, name, email, contact details, and role information.
- list-companiesList Freshdesk companies (GET /api/v2/companies). Optional pagination: page, per_page. Returns company id, name, domains, description, and other fields.
- list-contactsList Freshdesk contacts (GET /api/v2/contacts). Optional filters: email, phone, mobile, page, per_page. Returns contact id, name, email, phone, and other profile fields.
- list-groupsList Freshdesk agent groups (GET /api/v2/groups). Optional pagination: page, per_page. Returns group id, name, description, agent IDs, and other settings.
- list-ticket-conversationsList all conversations (replies and notes) on a Freshdesk ticket (GET /api/v2/tickets/{ticketId}/conversations). Optional pagination: page, per_page. Returns conversation id, body, incoming flag, user_id, and timestamps.
- list-ticketsList Freshdesk support tickets (GET /api/v2/tickets). Optional filters: status (2=open, 3=pending, 4=resolved, 5=closed), priority (1=low, 2=medium, 3=high, 4=urgent), page, per_page (default 30, max 100). Returns ticket id, subject, status, priority, requester, agent, timestamps.
- list-time-entriesList time entries for a Freshdesk ticket (GET /api/v2/tickets/{ticketId}/time_entries). Optional pagination: page, per_page. Returns time entry id, agent_id, billable, time_spent, note, and timestamps.
- reply-to-ticketReply to a Freshdesk ticket (POST /api/v2/tickets/{ticketId}/reply). Sends a public reply visible to the requester. Requires body (HTML content). Returns the created conversation entry.
- search-ticketsSearch Freshdesk tickets using a query string (GET /api/v2/search/tickets?query="{query}"). Supports field-based queries like "status:2 AND priority:3", "tag:'billing'", "created_at:>'2024-01-01'". Returns matching tickets with total count. Max 30 results per page.
- update-ticketUpdate an existing Freshdesk support ticket (PUT /api/v2/tickets/{ticketId}). Can change status (2=open, 3=pending, 4=resolved, 5=closed), priority (1=low, 2=medium, 3=high, 4=urgent), subject, or description. Returns the updated ticket.
03
Autenticación y permisos
Qué pide.
Declarado en el manifiesto y por adelantado. La aplicación no puede alcanzar nada que no haya pedido aquí.
Secretos de usuario
DOMAINAPI_KEY
Seguir leyendo
El manifiesto y el código de Freshdesk están en el monorepo, junto al resto de aplicaciones.