Helpdesk Content API

Overview

The Helpdesk Content API exposes everything your help desk contains — help centers, the collection tree, and every article in every language — as raw JSON. Pull the content into your own database and render a fully custom help site with your own design, on your own domain. Content endpoints are read-only (GET); authoring stays in the dashboard, and the hosted help center keeps working unchanged alongside it.

Authentication

Use your existing Data API key from Settings → API Keys (the same sk_live_ key the External Data API uses), passed in the X-Api-Key header or as a Bearer token.

curl -H "X-Api-Key: sk_live_YOUR_KEY" \
  https://api.nextcap.ai/api/v1/external/help/centers

Localized Fields

Localized fields (title, summary, description, body) are locale maps like { "en": "…", "fr": "…" } — one response carries every translation, and article body values are Markdown. To match the hosted help center, treat an article as translated into a locale only when both title[locale] and body[locale] are non-empty, and fall back to the center's default_locale otherwise.

Help Centers

{
  "data": [
    {
      "id": "uuid",
      "slug": "acme-support",
      "name": "Acme Support",
      "description": "How to get the most out of Acme",
      "scope": "agent",
      "default_locale": "en",
      "locales": ["en", "fr", "es"],
      "primary_widget_id": "uuid",
      "custom_domain": "help.acme.com",
      "created_at": "2026-05-01T09:00:00.000Z",
      "updated_at": "2026-07-01T14:30:00.000Z"
    }
  ]
}

Collections & Categories

{
  "data": [
    {
      "id": "uuid",
      "help_center_id": "uuid",
      "parent_id": null,
      "slug": "billing",
      "title": { "en": "Billing", "fr": "Facturation" },
      "description": { "en": "Plans, invoices, refunds" },
      "icon": "RiBankCardLine",
      "position": 0,
      "created_at": "2026-05-01T09:00:00.000Z",
      "updated_at": "2026-06-20T11:00:00.000Z"
    }
  ]
}

Articles

{
  "data": [
    {
      "id": "uuid",
      "help_center_id": "uuid",
      "collection_id": "uuid",
      "category_id": null,
      "slug": "getting-started",
      "title":   { "en": "Getting started", "fr": "Premiers pas" },
      "summary": { "en": "Set up your account in five minutes" },
      "body":    { "en": "## Welcome\n\nFirst, …", "fr": "## Bienvenue\n\n…" },
      "cover_image_url": null,
      "seo_title": null,
      "seo_description": null,
      "og_image": null,
      "tags": ["onboarding"],
      "status": "published",
      "visibility": "both",
      "position": 0,
      "author": { "name": "Jane Doe", "avatar_url": "https://…" },
      "published_at": "2026-07-01T10:00:00.000Z",
      "created_at": "2026-06-20T09:00:00.000Z",
      "updated_at": "2026-07-02T14:30:00.000Z",
      "deleted_at": null
    }
  ],
  "meta": { "page": 1, "per_page": 20, "total": 58, "total_pages": 3 }
}

Public visibility on the hosted help center means status = published and visibility of both or helpcenter_only — mirror that filter for parity (widget_only articles belong to the in-chat Help tab, hidden to neither surface).

Keeping Your Copy in Sync

Webhook Events

Thirteen events cover the content graph: help_center.*, help_collection.*, help_category.* (created / updated / deleted), plus help_article.created / updated / published / deleted. help_article.published fires on the draft → published transition and is the typical "rebuild my public site" trigger. Setup, payload format, signature verification, and retry behavior are on the Webhooks page.

Engagement Beacons (Optional)

The hosted help center records page views and "was this helpful?" votes that power the dashboard's Insights. Your custom frontend can keep that data flowing through the same public, unauthenticated beacons — they are browser-safe and need no API key.