canonical: https://jentic.com/apis/canhelpto.com/canhelpto # canhelpto public API The canhelpto API runs a lightweight support desk for one workspace: it opens tickets, lists a customer's tickets, reads a ticket with its public replies, and posts new replies on the conversation. Customers can close or reopen their own ticket, rate a resolved ticket from 1 to 5 for CSAT, and leave quick GOOD, NEUTRAL, or BAD feedback with a comment. Service-mode actions such as changing a ticket's status, priority, category, or assignee need the workspace service key, and the API also exposes the configuration the embedded web widget loads. Every request is scoped to the single workspace that owns the key. ## For AI agents Open and track customer support tickets, post replies, collect CSAT ratings, and read the widget configuration for one canhelpto workspace. Every call is scoped to the workspace that owns the API key. ## Scope Does not handle live chat, email sending, or phone support. Use for workspace support tickets, replies, and CSAT feedback only. ## Capabilities - Open a support ticket on behalf of a customer with a subject and first message - Post public replies on an existing ticket so the conversation continues - Let a customer close or reopen their own ticket by its id - Collect a 1-to-5 CSAT rating when a ticket is resolved - Capture quick GOOD, NEUTRAL, or BAD feedback with a comment - Read the workspace widget configuration the embedded web widget loads ## Use cases ### Agent-Run Support Triage An AI support agent opens tickets, posts replies, and tracks resolved conversations for a single canhelpto workspace through Jentic. Because every call carries the workspace key in the X-API-Key header, the agent only ever touches that one workspace's tickets, and a rule can keep it on reading and replying while service-mode status changes stay with a human. The agent discovers the right operation by intent and calls it directly. Example prompt: Open a ticket about a failing mobile checkout, post the first reply with a troubleshooting step, then read the ticket until the customer closes it. ### Customer Self-Service Ticketing A web app lets customers open support tickets, read the public replies on them, and close or reopen a ticket themselves. canhelpto handles one workspace per key, returns each ticket with its public replies, and lets the customer flip a ticket's status without any service-mode access. This keeps a lightweight help desk running behind a single embedded widget. Example prompt: List the current customer's open tickets, read the latest replies on each, and reopen the one they say was closed too early. ### Post-Resolution CSAT and Feedback After a ticket is resolved, collect a 1-to-5 CSAT score from the link in the resolution email and capture quick GOOD, NEUTRAL, or BAD feedback with a comment. canhelpto exposes the CSAT rating endpoint publicly so the emailed link works without a key, while feedback and ticket operations stay behind the workspace key. Teams use this to measure support quality per resolved ticket. Example prompt: Record a CSAT rating of 5 for a resolved ticket and log a GOOD feedback entry with the comment 'fast and clear'. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/api/v1/tickets` | Open a support ticket | | GET | `/api/v1/tickets` | List a customer's tickets | | GET | `/api/v1/tickets/{ticketId}` | Read a ticket with its public replies | | POST | `/api/v1/tickets/{ticketId}/replies` | Post a reply on a ticket | | PATCH | `/api/v1/tickets/{ticketId}/status` | Close or reopen a ticket | | POST | `/api/v1/feedback` | Submit quick GOOD, NEUTRAL, or BAD feedback | | GET | `/api/v1/widget-config` | Load the workspace widget configuration | ## Key resources - **Tickets** — Open a ticket, list a customer's tickets, read a ticket with its public replies, and change a ticket's status, priority, category, or assignee in service mode - **Replies** — Public replies posted on a ticket by the customer or, in service mode, the vendor - **Feedback and CSAT** — Quick GOOD, NEUTRAL, or BAD feedback and 1-to-5 CSAT ratings on resolved tickets - **Widget configuration** — The workspace settings the embedded web widget loads ## AI readiness This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use. - **Score:** 61 / 100 - **Maturity:** AI-Aware - **Dimensions:** - Foundational Compliance: 93 / 100 - Developer Experience & Jentic Compatibility: 60 / 100 - AI-Readiness & Agent Experience: 45 / 100 - Agent Usability: 94 / 100 - Security: 50 / 100 - AI Discoverability: 58 / 100 - **View full report:** https://jentic.com/apis/canhelpto.com/canhelpto/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **Setup:** Wiring the canhelpto API by hand means handling its workspace key in the `X-API-Key` header, keeping the public widget key separate from the service key, and remembering the CSAT endpoint is open. Through Jentic you install once, import canhelpto from the API Directory, store the key once, and your agent calls it. - **Permission scoping:** canhelpto puts the ticket id in the URL path, so a rule can pin your agent to the ticket-read and reply operations and keep service-mode changes out. You choose the operations it may call, so status changes, reassignment, and category edits are not included unless you add them. - **Credential handling:** Your canhelpto workspace key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'open a support ticket' or 'collect a CSAT rating', and Jentic returns the matching canhelpto operation with its input schema so the agent calls the right endpoint without reading the reference docs. ## Related APIs - **Zendesk** — A full help desk platform with ticketing, a knowledge base, and multi-channel support. - **Intercom** — Customer messaging and support with a shared inbox, bots, and a help center. - **Slack** — Team messaging used to notify people when a new support ticket arrives. ## FAQ ### What authentication does the canhelpto API use? The canhelpto API authenticates with a workspace key sent in the `X-API-Key` header, per its OpenAPI spec. The public key (your widget id) opens what the widget can do, while service-mode actions such as changing a ticket's status need the workspace service key. The CSAT rating endpoint is public so the link in a resolution email works without a key. Through Jentic the key is stored encrypted by your own Jentic One instance and injected only at call time. ### Can I open and reply to support tickets with the canhelpto API? Yes. The API opens a ticket, lists a customer's tickets, reads a ticket with its public replies, and posts new replies on it. A customer can also close or reopen their own ticket, while updating a ticket's status, priority, category, or assignee is a service-mode action that needs the service key. ### What are the rate limits for the canhelpto API? The OpenAPI spec does not specify rate limits for the canhelpto API. Check the vendor's agent documentation at https://canhelpto.com/docs/agents for current limits before pointing an agent at it. ### Can I limit what my agent is allowed to do with the canhelpto API? Yes. Write a rule that allows only the ticket-read and reply operations, so the agent can open tickets, read them, and respond, but cannot run service-mode changes such as reassigning a ticket or editing its category. Every call carries your workspace key, is logged, and the agent never sees the key itself. ### Is there a canhelpto MCP server? You don't need an MCP server to give your agent the canhelpto API. Jentic connects it directly from the API Directory: import it, store your workspace key once, and your agent calls the ticket, reply, and feedback operations. You skip loading another server's tool definitions into the agent's context. ### How do I handle support tickets with the canhelpto API through Jentic? Add the canhelpto API from the Jentic API Directory and store your workspace key once. Then your agent searches by intent such as 'open a support ticket' and Jentic returns the matching operation with its input schema, so it can open the ticket and post the first reply. To run it on your own infrastructure, install Jentic One from its GitHub repo.