Version history and release notes for the cStar REST API. Track new features, improvements, and breaking changes.

API Changelog

Version history and release notes for the cStar API.

Versioning

The API uses URL versioning: /api/v1/...

Breaking changes will result in a new version (v2, v3, etc.). Non-breaking additions are made to the current version.

December 2025

2025-12-14 - Webhooks System Launch

New Features:

  • Complete webhook system with 13 event types
  • HMAC-SHA256 signature verification
  • Automatic retries with exponential backoff
  • Auto-disable after consecutive failures
  • REST Hooks protocol for Zapier integration
  • Flat payload option for visual builders
  • Webhook testing and delivery logs

New Endpoints:

  • GET/POST /teams/{teamId}/webhooks - List/create webhooks
  • GET/PATCH/DELETE /teams/{teamId}/webhooks/{webhookId} - Manage webhooks
  • POST /teams/{teamId}/webhooks/{webhookId}/test - Test delivery
  • POST /teams/{teamId}/webhooks/subscribe - REST Hooks subscribe
  • DELETE /teams/{teamId}/webhooks/subscribe/{id} - REST Hooks unsubscribe
  • GET /teams/{teamId}/webhooks/sample/{event} - Sample payloads

New Events:

  • ticket.created, ticket.updated, ticket.closed
  • customer.created, customer.updated
  • article.created, article.updated, article.published
  • boss.spawned, boss.defeated
  • player.level_up, achievement.unlocked
  • survey.submitted

2025-12-10 - REST API Launch

New Features:

  • Full REST API for tickets, customers, and articles
  • API key authentication (secret and publishable)
  • Rate limiting (1000/hr secret, 100/hr publishable)
  • Pagination with cursor support
  • OpenAPI 3.1 specification
  • Interactive API documentation

New Endpoints:

  • GET/POST /teams/{teamId}/tickets - List/create tickets
  • GET/PATCH/DELETE /teams/{teamId}/tickets/{ticketId} - Manage tickets
  • GET/POST /teams/{teamId}/tickets/{ticketId}/messages - Ticket messages
  • GET/POST /teams/{teamId}/customers - List/create customers
  • GET/PATCH/DELETE /teams/{teamId}/customers/{customerId} - Manage customers
  • GET/POST /teams/{teamId}/articles - List/create articles
  • GET/PATCH/DELETE /teams/{teamId}/articles/{articleId} - Manage articles

API Stability

Stable

  • All documented endpoints
  • Response format structure
  • Authentication method
  • Rate limit headers

Beta

  • Webhook payload structure may evolve
  • New fields may be added to responses

Deprecation Policy

When we deprecate an endpoint:

  1. Announcement 90 days in advance
  2. Deprecation header added to responses
  3. Documentation updated with migration guide
  4. Old version supported for 6 months minimum

Subscribe to Updates

Get notified about API changes:

  1. Watch our changelog for updates
  2. Check the Deprecation header in responses
  3. Monitor webhook payloads for new fields