Put your help center on your own website

Your help center is hosted for you, but your articles can also live on your own website, at an address like yourcompany.com/help, in your site's own design. That's how this help center works: you're reading it on ongoing.ai/help.

#Two ways to publish

• Hosted: nothing to set up. Choose View site in Help center for its address, and link to it from your website.
• On your own site: your site fetches your published collections and articles from the help center API and renders them with your own pages and styles.

#The help center API

These endpoints are public and need no key; they only ever return published articles. Replace HELP_CENTER_ID with the last part of your hosted help center's address.

GET https://app.ongoing.ai/api/public/hc/HELP_CENTER_ID
GET https://app.ongoing.ai/api/public/hc/HELP_CENTER_ID/collections
GET https://app.ongoing.ai/api/public/hc/HELP_CENTER_ID/collections/{slug}
GET https://app.ongoing.ai/api/public/hc/HELP_CENTER_ID/articles
GET https://app.ongoing.ai/api/public/hc/HELP_CENTER_ID/articles/{slug}
GET https://app.ongoing.ai/api/public/hc/HELP_CENTER_ID/search?q=…

An article comes with its HTML (already cleaned and safe to render), its collection for breadcrumbs, its author, and related articles from the same collection.

#Build the pages

1. /help: a search box, then your collections.
2. /help/collections/{slug}: a collection's articles, in order.
3. /help/articles/{slug}: the article.

Two details to get right:

• Images in article HTML use paths starting with /api/public/. Prefix them with https://app.ongoing.ai on your site.
• Cache responses for a few minutes. Your pages stay fast, and new articles appear soon after you publish them.

#Keep the messenger close

With the messenger installed, visitors can search the same articles from its Help tab, and a Chat with us button on your article pages can open it with Intercom('showNewMessage').