CRMcy Docs

Knowledge base

Public articles for self-service support.

Last updated 2026-05-05

The knowledge base hosts customer-facing articles grouped by category. Articles render at https://<your-slug>.crmcy.app/kb (and a custom domain if you've configured one) with full-text search, related-article suggestions, and an embedded "Was this helpful?" feedback widget that writes anonymous votes back to the article. Drafts and published articles are kept separate; staff with the kb.publish permission can promote a draft.

Articles support the same Markdown-with-merge-fields format used elsewhere in CRMcy, so you can reference the customer's name, tenant name, or ticket id when a KB article is surfaced inline from a ticket reply.

Related endpoints

  • GET /api/tenant/kb/articles — list (staff view).
  • POST /api/tenant/kb/articles — create draft.
  • POST /api/tenant/kb/articles/:id/publish — publish.
  • GET /api/public/kb/:tenantSlug/articles — public list.
  • POST /api/public/kb/:tenantSlug/articles/:slug/feedback — vote.

See the source at apps/web/src/app/(tenant)/kb and apps/api/src/kb.