All articles

Widget and help center

Write your help articles in Ingot

Connect an Ingot dataset. Your help center then shows the articles that you publish there.

Ingot is the content management system of Obsidian Heron. You can write the articles of your help center in Ingot. OHSupport keeps a copy of each published article in its own search index. The help center is fast, and the search finds words in the articles.

Each article has a title, a slug, a body, a category and a brand. An article without a brand shows for all brands of your tenant.

Before you start

You need an Ingot project and a dataset. You need the admin role in Ingot to make tokens and webhooks. You also need the role owner or admin in OHSupport.

Connect Ingot

  1. In Ingot, add the help-center schema to your dataset with the command ingot schema deploy.
  2. Make a read token for the dataset. Set the role to Read and the perspective to Published only.
  3. In OHSupport, open Settings. Find the card Help center content (Ingot). Copy the webhook URL.
  4. In Ingot, add a webhook with that URL. Select the events create, update, delete, publish and unpublish.
  5. In the webhook, write the document types helpArticle and helpCategory. Select the Ingot payload format. Copy the signing secret.
  6. In the card in OHSupport, write the content API host, the project id, the dataset, the token and the secret.
  7. Select Connect.

How the articles stay current

When you publish or remove an article, Ingot sends a signed webhook. OHSupport reads the article again and updates its index. The help center changes after some seconds. The search box finds words in the title, the summary and the body.

If Ingot could not send webhooks for some time, select Sync now in the card. A full sync reads all published articles and categories again. The card shows the time and the result of the last sync.

NOTE: Ingot shows only published articles to OHSupport. OHSupport never shows a draft.

Limits

  • OHSupport does not index an article that has no title, or a slug with characters that are not permitted.
  • OHSupport keeps the first blocks only of a very long article.
  • OHSupport keeps the token and the secret with AES-GCM encryption. The API never shows them again.