Customer portal

Help center

Configure the built-in article site, branding and public article APIs.

Enable Customer portal and Help center in the business's Customer portal settings. Octocom provides these pages:

PathPage
/Home page with articles, categories and search.
/article/<article-id>A public article.
/category/<category-id>A category's public articles.

Only articles marked public are returned. Making an article public is separate from enabling the portal: a disabled portal does not serve its articles. Private articles do not become public when you enable the help center.

While the help center is enabled, these built-in paths take precedence over custom pages. To replace them with custom HTML, disable the help center and publish custom pages at the desired paths. Custom pages use exact paths; there is no article or category route template.

Branding

Open Customer portal → Help center to configure:

  • Logo and store URL.
  • Header text, background image, background color and text color.
  • Articles heading.
  • Header links, including links to your custom pages or external sites.
  • Social links.

Valid changes save automatically. Check the save notification and any field errors before leaving the page. There is no separate Save button. Articles and categories are managed in the knowledge base, not in the branding form.

Public article APIs

These unauthenticated GET endpoints are available on the portal's built-in address and connected custom domains:

EndpointResponse
/api/help-centerBusiness name, branding config, categories containing public articles, and public articles without a category.
/api/help-center/search?q=<text>Matching public articles. A nonempty search term is required.
/api/help-center/article/<article-id>One public article, its content and category information.
/api/help-center/category/<category-id>Category information and its public articles.

The hostname selects the business. Callers cannot select another business with a query parameter. Unknown or private articles return 404.

The APIs require the portal to be enabled and either Help center or Public article API for custom pages to be enabled. You can therefore build your own article UI without using the built-in pages. That API setting exposes public article content without authentication; it does not expose private articles.

Custom pages run in a sandbox. Fetch without credentials:

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>Our help center</title>
  </head>
  <body>
    <h1 id="name">Help center</h1>
    <script>
      fetch("/api/help-center", { credentials: "omit" })
        .then((response) => {
          if (!response.ok) throw new Error("Help center unavailable");
          return response.json();
        })
        .then((data) => {
          document.getElementById("name").textContent = data.businessName;
        });
    </script>
  </body>
</html>

On this page