# cStar

> cStar is a customer support platform built for small teams. Customers see a clean professional surface; agents see XP, boss battles, achievements, quests. Flat $15/seat. No upcharges.

## Docs

- [Developer Portal](https://cstar.help/developers): Hub for SDKs, REST API, webhooks, and CLI.
- [Quickstart](https://cstar.help/developers/quickstart): First API call working in a few minutes.
- [API Reference](https://cstar.help/developers/api-reference): Every resource, endpoint, and field.
- [Errors](https://cstar.help/developers/errors): Error shape, codes, and how to catch them.
- [Webhooks Guide](https://cstar.help/developers/webhooks): Subscribe, verify, retry semantics.
- [CLI Reference](https://cstar.help/developers/cli): `cstar listen`, `cstar trigger`, `cstar mcp-server`.
- [API Playground](https://cstar.help/developers/playground): Browser-side request runner.
- [Principles — The Code of cStar](https://cstar.help/developers/principles): The opinions behind the API.
- [Cheat Sheets](https://cstar.help/developers/cheatsheets): Single-page references per surface.
- [Changelog](https://cstar.help/developers/changelog): Release notes.

## Machine surfaces

- [llms-full.txt](https://cstar.help/llms-full.txt): Full reference for AI tooling — resources, webhooks, SDK shapes.
- [cstar-ai-context.md](https://cstar.help/developers/cstar-ai-context.md): Drop-in CLAUDE.md / .cursor/rules file.
- [OpenAPI Spec](https://cstar.help/openapi.yaml): OpenAPI 3.1 description of the REST API.
- [Postman Collection](https://cstar.help/developers/postman.json): Importable Postman collection.

## API at a glance

- Base URL: `https://www.cstar.help/api/v1/teams/{teamId}`
- Auth: `Authorization: Bearer sk_live_*` (server-side) or `pk_live_*` (read-only, browser-safe).
- Rate limits: 1000 req/hour for secret keys, 100 req/hour for publishable keys.
- REST envelope: lists return `{ success, data, pagination, meta: { requestId, timestamp } }`; single-object responses (get/create/update) wrap the same way at the REST layer.
- SDK envelope: the JS/React/Svelte SDKs **unwrap single-object responses** so methods like `cstar.tickets.get(id)` resolve to the ticket directly. List methods still return the `{ data, pagination, hasMore }` shape. Codegen tools targeting raw REST should not assume the SDK shape.
- Errors: `{ success: false, error: { type, code, message, doc_url, request_id } }`. The `x-cstar-request-id` response header always equals `meta.requestId` and `error.request_id` — paste any of them into a support thread.

## Resources

- [Tickets](https://cstar.help/developers/api-reference/tickets): Tickets are the core of cStar — each one represents a customer support conversation. Create, update, and resolve tickets through the API.
- [Customers](https://cstar.help/developers/api-reference/customers): Customers represent the people who submit tickets. Track their history, sentiment, and metadata across all interactions.
- [Customer Groups](https://cstar.help/developers/api-reference/customer-groups): Customer groups let you organize customers into flexible categories — like Zendesk organizations, Intercom companies, or custom segments. Customers can belong to multiple groups.
- [Articles](https://cstar.help/developers/api-reference/articles): Articles power your knowledge base. Create, publish, and manage help content that customers and agents can search.
- [Messages](https://cstar.help/developers/api-reference/messages): Messages belong to tickets and represent the conversation thread between agents and customers. Each message has a sender type and optional metadata.
- [Webhooks](https://cstar.help/developers/api-reference/webhooks): Webhooks notify your application in real-time when events happen in cStar. Subscribe to ticket, customer, article, and gamification events.
- [Categories](https://cstar.help/developers/api-reference/categories): Categories organize your knowledge base articles into logical groups. Customers see public categories when browsing your help center.
- [Community](https://cstar.help/developers/api-reference/community): Community posts let customers ask questions, share feedback, and vote on feature requests. Agents can manage posts, set statuses, and moderate content.
- [Members](https://cstar.help/developers/api-reference/members): Team members are the agents and admins who use cStar. Manage roles, view stats, and send invites.
- [Settings](https://cstar.help/developers/api-reference/settings): Team settings control statuses, quick replies, business hours, and widget appearance. Secret key required.
- [Notifications](https://cstar.help/developers/api-reference/notifications): In-app notifications for team members. List, read, and manage notification state.
- [Custom Fields](https://cstar.help/developers/api-reference/custom-fields): Define custom data fields for tickets and customers. Supports text, number, select, date, and boolean types.
- [SLA Rules](https://cstar.help/developers/api-reference/sla): Service Level Agreement rules define response and resolution time targets by ticket priority.
- [Analytics](https://cstar.help/developers/api-reference/analytics): Team performance analytics, agent stats, and CSAT data. All analytics endpoints require a secret key.
- [Bulk Operations](https://cstar.help/developers/api-reference/bulk): Perform bulk updates or deletes on tickets, customers, or articles. Max 100 items per request.
- [Export](https://cstar.help/developers/api-reference/export): Export tickets, customers, or articles as JSON or CSV. Synchronous — max 10,000 rows per resource.
- [Import](https://cstar.help/developers/api-reference/import): Import tickets, customers, or articles. Synchronous processing — max 500 records per request. Supports merge strategies.
- [Audit Log](https://cstar.help/developers/api-reference/audit-log): Immutable audit trail of all actions taken in your team. Filter by action, resource, actor, or date range.
- [Search](https://cstar.help/developers/api-reference/search): Search across tickets, customers, and articles in a single query. Works with publishable keys (read-only).
- [Tags](https://cstar.help/developers/api-reference/tags): Manage tags used across tickets. List tags with usage counts, create new ones, or remove unused tags.
- [Game](https://cstar.help/developers/api-reference/game): The cStar gamification system — player stats, boss battles, leaderboards, achievements, quests, puzzles, social features, cosmetics, seasons, and skill trees. Read endpoints accept any API key; write endpoints require a secret key.
- [AI Actions](https://cstar.help/developers/api-reference/ai): AI-powered actions for ticket management — auto-tag tickets, generate reply suggestions, summarize conversations, and improve draft text.
- [Automations](https://cstar.help/developers/api-reference/automations): Automation rules that trigger actions when specific events occur. Rules have conditions, actions, and can be tested with dry runs.
- [Saved Views](https://cstar.help/developers/api-reference/views): Saved filter presets for tickets, customers, articles, or community posts. Create reusable views and execute them to get filtered results.
- [Billing](https://cstar.help/developers/api-reference/billing): Access subscription status and create Stripe billing portal sessions. Secret key required.

## SDKs

- [@cstar.help/js](https://cstar.help/developers/sdk/js) v0.15.1: Core client. `new CStarClient({ apiKey, teamId })`. Subpaths: `/auth`, `/library`, `/community`, `/chat`, `/quickhelp`, `/proactive`, `/webhook`.
- [@cstar.help/react](https://cstar.help/developers/sdk/react) v0.10.0: `<CStarProvider>`, `useTickets`, `useCustomers`, `useArticles`, `useCStarClient`, `useSubscription`.
- [@cstar.help/svelte](https://cstar.help/developers/sdk/svelte) v0.9.0: Svelte 5 rune classes — `TicketsState`, `MessagesState`, `ArticlesState`, etc. Constructor shape: `new ArticlesState(client?, params?)` (client first, params second). Reactive fields: `.tickets / .articles / .isLoading / .error`. Subscribers (MessagesState, TypingState, ArticleSearchState) require `destroy()` on unmount.
- [@cstar.help/cli](https://cstar.help/developers/cli) v0.8.2: `cstar login`, `cstar status`, `cstar listen`, `cstar trigger`, `cstar logs`, `cstar mcp-server`.

## Webhook events

Events follow the `resource.action` pattern. Signatures use the Stripe-style `X-Signature: t=<unix>,v1=<hex>` header (legacy `sha256=<hex>` is still verified for back-compat).

- ticket.created: Fired when a new ticket is created via app, widget, API, or email
- ticket.updated: Fired when a ticket status, priority, or assignment changes
- ticket.closed: Fired when a ticket is resolved or closed
- ticket.message_added: Fired when a new message is added to a ticket
- ticket.deleted: Fired when a ticket is deleted via app or API
- ticket.assigned: Fired when a ticket is assigned to an agent
- customer.created: Fired when a new customer is created
- customer.updated: Fired when customer details are modified
- customer.deleted: Fired when a customer is deleted via app or API
- customer_group.created: Fired when a customer group is created
- customer_group.updated: Fired when a customer group is modified
- customer_group.deleted: Fired when a customer group is deleted
- article.created: Fired when a new Library article is created
- article.published: Fired when an article is published to the Public Library
- article.updated: Fired when an article content or metadata is modified
- article.deleted: Fired when an article is deleted via app or API
- team.preferences_updated: Fired when team-wide UX preferences change (e.g., bossBattlesEnabled toggled)
- agent.preferences_updated: Fired when an agent's per-user UX preferences change (e.g., boringMode toggled)
- boss.spawned: Fired when a boss appears for the team
- boss.damaged: Fired when a boss takes damage from a ticket close
- boss.defeated: Fired when a boss is defeated by the team
- player.level_up: Fired when a player reaches a new level
- player.achievement_unlocked: Fired when a player unlocks an achievement
- player.xp_gained: Fired when a player earns XP from closing a ticket or quest
- player.quest_completed: Fired when a player completes a daily quest
- player.streak_milestone: Fired when a player hits a streak milestone (3, 5, 10, or 25 days)
- social.one_up_sent: Fired when a teammate sends a one-up recognition
- social.high_five_sent: Fired when a team sends a high five to another team
- community_post.created: Fired when a new community post is created
- community_post.updated: Fired when a community post is updated
- community_post.status_changed: Fired when a community post status is changed (e.g., Planned, Completed)
- community_post.commented: Fired when a new comment is added to a community post
- community_post.deleted: Fired when a community post is deleted
- community_post.voted: Fired when a community post receives a vote
- survey.submitted: Fired when a customer submits a CSAT survey response

## Site

- [Homepage](https://cstar.help)
- [Pricing](https://cstar.help/pricing): $15/seat. That's the pitch.
- [Blog](https://cstar.help/blog)
- [Roadmap](https://cstar.help/roadmap)
- [Privacy](https://cstar.help/privacy)
- [Terms](https://cstar.help/terms)

## Contact

- Email: hello@cstar.help