> For the complete documentation index, see [llms.txt](https://docs.snapfix.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snapfix.com/product/features/help/help-hub.md).

# Help Hub

{% hint style="info" %}
Draft, written by an agent and not yet checked by a person ([how to read these docs](https://docs.snapfix.com/how-to-read.md)). [Source on GitHub](https://github.com/snapfix/docs/blob/main/product/features/help-hub.md).
{% endhint %}

The **Help Hub** is the in-app help for signed-in users of the mobile apps. It gathers answers to common questions (the **FAQ**), **Snaptips** (the [quick tour](https://docs.snapfix.com/product/features/help/quick-tour.md)), **help videos**, a note that analytics are in the web app, and the **Get in touch** form ([Contacting support](https://docs.snapfix.com/product/features/help/contact-support.md)). The web has no Help Hub screen: its side menu's "HelpHub" item offers the quick tour and links to the public help center. People who cannot sign in get the same FAQ, and the contact form, on the "Help with logging in" page. The Help Hub exists so that people can find answers without contacting support.

## Rules

### Who can open it, and where

* Every signed-in user opens the Help Hub and sees every row. Neither app checks the role, the site or the group ([Help Hub](https://docs.snapfix.com/how-the-apps-work/screens/help/help-hub.md#states)).
* On iOS and Android the side menu's "HelpHub" opens the "Help Hub" tab of the profile hub (My Profile on Android). "Learn More", at the end of the welcome tour, also opens it ([Help Hub](https://docs.snapfix.com/how-the-apps-work/screens/help/help-hub.md)).
* Android has two copies of the screen: My Profile's tab, which the side menu opens, and `HelpHubActivity`, which only "Learn More" opens and whose texts are written in English in the code. Which copy stays is open \[[ASK-190](https://github.com/snapfix/docs/blob/main/ASK.md#ask-190-which-android-help-hub-should-stay-my-profiles-tab-or-the-separate-screen)] ([Help Hub](https://docs.snapfix.com/how-the-apps-work/screens/help/help-hub.md#android)).
* The iOS top bar has a Help Hub button in the code, but it is always hidden.
* The web has no Help Hub screen. Its side menu's "HelpHub" item opens a menu with "Take A Quick Tour", "Help Articles", "Training Videos" and "Contact support". The last three open pages of the public help center in a new tab, and the help center has broken links. So signed-in web users have no in-app FAQ, help videos or contact form \[[ASK-195](https://github.com/snapfix/docs/blob/main/ASK.md#ask-195-should-signed-in-web-users-get-the-in-app-contact-form)] ([Help Hub](https://docs.snapfix.com/how-the-apps-work/screens/help/help-hub.md)).
* Android's My Profile settings also link to the help center: "Help Articles", "Training Videos" and "Contact Support"; the last opens a help center page that no longer exists (android @ 86068bfeea, `app/src/main/java/gmail/com/snapfixapp/activity/MyProfileActivity.kt:717-730`, `app/src/main/res/layout/layout_content_profile_settings.xml:775-826`).

### Contents

* The apps' Help Hub has four rows, "Frequently Asked Questions", "Snaptips", "Help Videos" and "Analytics", and a "GET IN TOUCH" button. Each row and the button log an analytics event ([Help Hub](https://docs.snapfix.com/how-the-apps-work/screens/help/help-hub.md#layout)).
* "Analytics" opens a note, "Log in to Snapfix on your desktop to access Dashboards, Reports and Data Analytics.", with a close button. It makes no API call. Its "Snapfix Web Login" button, whose link points at a web page that does not exist, is hidden on both apps, so the note has no working link ([Analytics note](https://docs.snapfix.com/how-the-apps-work/screens/help/help-hub.md#analytics-note)).
* "Snaptips" opens the tour page; its rules are in [Quick tour](https://docs.snapfix.com/product/features/help/quick-tour.md). "GET IN TOUCH" opens the form; its rules are in [Contacting support](https://docs.snapfix.com/product/features/help/contact-support.md).

### FAQ

* The FAQ is the help API's category `faq`. Signed-in users load it with their token; the sign-in help loads the same list with the shared guest login ([Help API](https://docs.snapfix.com/engineering-reference/api/help.md#get-v1apphelp-hubcategory)).
* The server reads the articles from the source its `HELPHUB_PROVIDER` setting names: the built-in file, which is the default, or HubSpot (api\_php\_live\_v2 @ ef3c4319f6, `config/helphub.php:11`). Production serves the built-in file: on 2026-11-14 the live sign-in help page showed exactly its seven articles. The other six categories have no file and answer an empty list ([Help API](https://docs.snapfix.com/engineering-reference/api/help.md#get-v1apphelp-hubcategory)).
* None of the seven articles is about signing in, although the sign-in help shows them.
* With the HubSpot source each answer would arrive as one string, which no platform reads, so the FAQ would break on all three, and each load would fetch every article page. Neither happens with the built-in source.
* The search filters the list already loaded and sends no request. It matches the title, the description or a content line, ignoring case. A search with no match shows an empty list with no message in the apps, and two texts at once on the web ([FAQ](https://docs.snapfix.com/how-the-apps-work/screens/help/faq.md#inputs), [Help with logging in](https://docs.snapfix.com/how-the-apps-work/screens/help/login-help.md#inputs)).
* The server sends the FAQ in English in every language. Android translates each question and answer on the phone when the selected site has AI language translation on; iOS and the web always show the English text \[[ASK-191](https://github.com/snapfix/docs/blob/main/ASK.md#ask-191-should-the-faq-be-translated-on-ios-and-the-web-as-on-android)] ([FAQ](https://docs.snapfix.com/how-the-apps-work/screens/help/faq.md#platform-differences)).
* The FAQ does not read [`tPub_Help`](https://docs.snapfix.com/engineering-reference/db/tables/tpub_help.md). Two generic actions on that table have no caller ([Help API](https://docs.snapfix.com/engineering-reference/api/help.md)).

### Help videos

* The help videos are five fixed videos, in the same order on both apps. The list and the links are in each app's code, so the list changes only with a release ([Help videos](https://docs.snapfix.com/how-the-apps-work/screens/help/help-videos.md#layout)).
* Two of the videos share one description, and iOS shows the titles in title case where Android shows capitals.
* A video plays from its file host, not through the Snapfix API ([Help videos](https://docs.snapfix.com/how-the-apps-work/screens/help/help-videos.md#actions)).

### Sign-in help

* Signed-out users reach "Help with logging in" from the "HelpHub." link on the sign-in and password screens. It shows the FAQ, its search and a "Get In Touch" button ([Help with logging in](https://docs.snapfix.com/how-the-apps-work/screens/help/login-help.md)).
* On the web the page is `/auth/help-hub-faq`, and a signed-in user who opens it goes to `/fix`. On iOS it is the FAQ screen in its signed-out mode; Android has its own screen ([Help with logging in](https://docs.snapfix.com/how-the-apps-work/screens/help/login-help.md)).

## Flow

```mermaid
flowchart TD
  start["User looks for help"] --> signed{"Signed in?"}
  signed -- "no" --> login["Help with logging in: FAQ and search"]
  signed -- "yes, in the apps" --> hub["Help Hub: four rows and Get in touch"]
  signed -- "yes, on the web" --> side["Side menu HelpHub: quick tour and help center links"]
  hub --> faq["FAQ: search and open answers"]
  hub --> tips["Snaptips: quick tour"]
  hub --> videos["Help Videos: five videos"]
  hub --> note["Analytics note"]
  hub --> contact["Get in touch form"]
  login --> contact
  side --> center["Public help center, in a new tab"]
```

## Platforms

| Capability               | Web                                                                                                                                                 | iOS                                                   | Android                                                                                                                                                                                                                  |
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Help Hub screen          | No; the side menu's "HelpHub" item opens the quick tour and three help center links                                                                 | Yes, the profile hub's "Help Hub" tab                 | Yes, My Profile's "Help Hub" tab; a second copy opens from "Learn More" \[[ASK-190](https://github.com/snapfix/docs/blob/main/ASK.md#ask-190-which-android-help-hub-should-stay-my-profiles-tab-or-the-separate-screen)] |
| FAQ for signed-in users  | No                                                                                                                                                  | Yes                                                   | Yes                                                                                                                                                                                                                      |
| FAQ for signed-out users | Yes, "Help with Logging in"                                                                                                                         | Yes, "Help with Logging In"                           | Yes, "Help with Logging In"                                                                                                                                                                                              |
| FAQ translated           | No                                                                                                                                                  | No                                                    | Yes, with the site's AI language translation on \[[ASK-191](https://github.com/snapfix/docs/blob/main/ASK.md#ask-191-should-the-faq-be-translated-on-ios-and-the-web-as-on-android)]                                     |
| Help videos              | No; "Training Videos" opens the help center                                                                                                         | Five videos                                           | Five videos                                                                                                                                                                                                              |
| Snaptips                 | Yes, from the side menu                                                                                                                             | Yes                                                   | Yes                                                                                                                                                                                                                      |
| Analytics note           | No                                                                                                                                                  | Yes, with no working link                             | Yes, with no working link                                                                                                                                                                                                |
| Get in touch             | Signed-out users only \[[ASK-195](https://github.com/snapfix/docs/blob/main/ASK.md#ask-195-should-signed-in-web-users-get-the-in-app-contact-form)] | Signed-in and signed-out users                        | Signed-in and signed-out users                                                                                                                                                                                           |
| Help center links        | Three, in the "HelpHub" menu                                                                                                                        | None; the old side menu's "Contact Support" is hidden | Three, in My Profile's settings; "Contact Support" is broken                                                                                                                                                             |

## Screens

* [Help Hub](https://docs.snapfix.com/how-the-apps-work/screens/help/help-hub.md): the rows on iOS and Android, and the web's side-menu item.
* [FAQ](https://docs.snapfix.com/how-the-apps-work/screens/help/faq.md): the searchable answers for signed-in users, on iOS and Android.
* [Help videos](https://docs.snapfix.com/how-the-apps-work/screens/help/help-videos.md): the five videos, on iOS and Android.
* [Help with logging in](https://docs.snapfix.com/how-the-apps-work/screens/help/login-help.md): the FAQ for people who cannot sign in, on all three platforms.
* [Snaptips](https://docs.snapfix.com/how-the-apps-work/screens/help/snaptips.md) and [Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md) open from the Help Hub; they belong to [Quick tour](https://docs.snapfix.com/product/features/help/quick-tour.md) and [Contacting support](https://docs.snapfix.com/product/features/help/contact-support.md).

## API and data

* [`GET /v1/app/help-hub/{category}`](https://docs.snapfix.com/engineering-reference/api/help.md#get-v1apphelp-hubcategory): the FAQ for signed-in users, on iOS and Android.
* [`GET /v1/guest/help-hub/{category}`](https://docs.snapfix.com/engineering-reference/api/help.md#get-v1guesthelp-hubcategory): the FAQ on the sign-in help, on all three platforms.
* [Help article object](https://docs.snapfix.com/engineering-reference/api/help.md#help-article-object): each question and answer.
* [`POST /v1/app/help-hub`](https://docs.snapfix.com/engineering-reference/api/help.md#post-v1apphelp-hub) and [`POST /v1/guest/help-hub`](https://docs.snapfix.com/engineering-reference/api/help.md#post-v1guesthelp-hub): the contact form ([Contacting support](https://docs.snapfix.com/product/features/help/contact-support.md)).
* The help videos and the tours have no routes; their lists are in the apps and the web ([Help API](https://docs.snapfix.com/engineering-reference/api/help.md)).
* Tables: none for the FAQ. Contact messages go to [`tPri_Log_Helphub_ContactForm`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_log_helphub_contactform.md).

## Depends on

* [Quick tour](https://docs.snapfix.com/product/features/help/quick-tour.md): the Snaptips row, and the welcome tour whose "Learn More" opens the Help Hub.
* [Contacting support](https://docs.snapfix.com/product/features/help/contact-support.md): the "GET IN TOUCH" form.
* [Sign-in](https://docs.snapfix.com/product/features/account/sign-in.md) and [Password reset](https://docs.snapfix.com/product/features/account/password-reset.md): the screens that link to the sign-in help.
* [Profile and settings](https://docs.snapfix.com/product/features/account/profile.md): the profile hub that holds the Help Hub tab on both apps.
* [Dashboard](https://docs.snapfix.com/product/features/reports/dashboard.md): the web dashboards that the analytics note points to.
* The public help center at support.snapfix.com, outside these repos.
* Integrations: HubSpot, only if the server's FAQ source is switched to it.

## Edge cases

* **Offline (mobile):** the rows, Snaptips and the video list open. The FAQ and the form check the connection first and show the connection alert. A video plays with no check and fails in the player ([Help Hub](https://docs.snapfix.com/how-the-apps-work/screens/help/help-hub.md#states), [Help videos](https://docs.snapfix.com/how-the-apps-work/screens/help/help-videos.md#states)).
* **Offline on Android's sign-in help:** the page keeps only its toolbar and "GET IN TOUCH", and nothing reloads when the connection returns.
* **FAQ fails to load:** iOS shows an alert with the API's message. Android shows an empty list with no message. The web shows the API's message in its alert, and the two empty texts ([FAQ](https://docs.snapfix.com/how-the-apps-work/screens/help/faq.md#states)).
* **Refused guest login on the web:** the sign-in help signs the visitor out and opens the sign-in page, with no message.
* **Request limit:** the guest routes allow 60 calls a minute and 1,000 a day per IP address. Past the limit they answer "An unexpected error occurred. Please try again later." with `500`, not `429` ([Help API](https://docs.snapfix.com/engineering-reference/api/help.md#get-v1guesthelp-hubcategory)).
* **Temporary password or unverified contact:** the signed-in routes answer `428` or `409`, as every `/v1/app` route does ([shared API doc](https://docs.snapfix.com/engineering-reference/api.md#what-a-user-token-does-not-prove)).
* **Search on the web:** text that arrives without a key release, such as a paste from the menu, filters nothing until the next key.
* **Several sites and time zones:** none. The help routes check only the sign-in, not the site. Android's translation follows the selected site's setting.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.snapfix.com/product/features/help/help-hub.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
