Skip to content

Introduction

The SupportDesk REST API lets your backend drive SupportDesk without going through the widget: auto-create tickets, sync your customer base, log business events that appear in your agents’ timeline.

  • Create a ticket when a payment fails in your app
  • Sync the customer profile (plan, email, phone) as soon as it changes on your side
  • Enrich the context of a ticket with business events (order.placed, subscription.cancelled)
https://supportdesk.innovartx.com/api/v1
  • Requests and responses in JSON (Content-Type: application/json)
  • Auth via the X-API-Key: sk_live_agent_… header (API key created in Settings → API Keys)
  • Wrapped responses:
    { "success": true, "data": { /* … */ }, "timestamp": "2026-04-18T10:00:00Z" }
EndpointAction
PATCH /customers/:externalIdCreate or update a customer
POST /tickets/api-createCreate a ticket for an existing customer
POST /customer-eventsLog a business event

The API is versioned via URL prefix (/v1). As long as you stay on a given version, endpoints and formats don’t break. Non-breaking additions (new fields, new endpoints) are announced in the changelog.

→ Start with Authentication.