> 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/contact-support.md).

# Contacting support

{% 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/contact-support.md).
{% endhint %}

People reach the Snapfix support team in three ways. They fill in the **Get in touch** form, which stores the message and emails it to the support mailbox. They open the public help center's contact page from a link. Or, from some sign-in and sign-up screens of the apps, they write an email to support in their mail app. Signed-in app users find the form in the **Help Hub**; people who cannot sign in find it on "Help with logging in", on all three platforms. The form exists so that anyone, signed in or not, can ask for help. It opens no ticket.

## Rules

### Ways to reach support

* **The form.** iOS and Android offer it in the [Help Hub](https://docs.snapfix.com/product/features/help/help-hub.md) to signed-in users, and on the sign-in help to signed-out users. The web offers it only to signed-out users, at `/auth/get-in-touch`, from the "Get In Touch" button on the sign-in help; the web's sign-in routes send a signed-in user to `/fix` ([Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md)).
* **The help center's contact page.** On the web, the side menu's "HelpHub" > "Contact support" opens it in a new tab, so signed-in web users write to support there \[[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)). The other links to a contact page open one that no longer exists: Android's My Profile "Contact Support", the web multi-site console's "Customer Success", and the old iOS side menu's "Contact Support", which the new side menu covers.
* **Mail links.** The apps' "Need help? Contact support" links, on the sign-in screen and some password and registration screens, open the mail app addressed to `customersupport@snapfix.com`. The Get in touch screens name `support@snapfix.com`. Whether both reach the same inbox is open \[[ASK-192](https://github.com/snapfix/docs/blob/main/ASK.md#ask-192-which-support-address-should-the-apps-show-support-or-customersupport)] (ios @ aa31967ac8, `SnapFix/Registration/ChooseLoginVC.swift:111-124`; android @ 86068bfeea, `app/src/main/java/gmail/com/snapfixapp/fragment/LoginFragment.java:655`).

### The form

* It asks for a first name, a last name, an email address, a subject and a message. All five are required on every platform, and the send button stays off until the form is valid ([Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md#inputs)).
* The email must look like an address. Only the web says so on screen ("Please enter a valid email"); the server checks the address too ([Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md#inputs)).
* The server trims every field, then refuses an empty message and a message over 5,000 characters. No platform limits the message on screen, and the web and iOS let a message of spaces through, so these refusals come only after the send ([Contact form](https://docs.snapfix.com/engineering-reference/api/help.md#contact-form)).
* Android limits the names and the email to 100 characters. iOS trims the values before it sends them; the web and Android send them as typed ([Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md#platform-differences)).

### Who can send

* In the apps a signed-in user sends with their own token, and a signed-out user through the guest route. The web always uses the guest route ([Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md#actions)).
* The signed-in route accepts any signed-in user; no role, site or group is checked ([`POST /v1/app/help-hub`](https://docs.snapfix.com/engineering-reference/api/help.md#post-v1apphelp-hub)).
* The guest route uses one shared login that is also in the public web bundles, and asks for no CAPTCHA, so anyone with that login can send support emails. Each IP address may make 60 guest calls a minute and 1,000 a day, and blacklisted addresses and countries are refused ([`POST /v1/guest/help-hub`](https://docs.snapfix.com/engineering-reference/api/help.md#post-v1guesthelp-hub)).

### What a message does

* It is stored as one row of [`tPri_Log_Helphub_ContactForm`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_log_helphub_contactform.md), with the sender's user ID when signed in and no user when signed out ([Contact form](https://docs.snapfix.com/engineering-reference/api/help.md#contact-form)).
* It is emailed once to the support mailbox, the server's `APP_SUPPORT_EMAIL` (in the code, `support@snapfix.com` by default), with the subject "HelpHub Contact Form". The email holds the five fields; for a signed-in sender it adds their name, sign-in email and mobile number ([Contact form](https://docs.snapfix.com/engineering-reference/api/help.md#contact-form)).
* With the queue on Redis the email is sent after the answer, so a mail failure does not reach the sender; with the code default it is sent before the answer. The production setting is not in any repo \[[ASK-12](https://github.com/snapfix/docs/blob/main/ASK.md#ask-12-which-settings-do-the-production-api-servers-use)] ([Contact form](https://docs.snapfix.com/engineering-reference/api/help.md#contact-form)).
* The email has no reply-to address, so pressing reply does not reach the person who wrote.
* No HubSpot call is made and no ticket is created; the message also makes no push, task or chat. Whether messages should become HubSpot tickets is open \[[ASK-189](https://github.com/snapfix/docs/blob/main/ASK.md#ask-189-should-contact-form-messages-create-a-hubspot-ticket)].
* The row is written by the HubSpot help class, which needs the server's HubSpot token. Without the token every send fails with `500` before anything is stored.
* Nothing in the repos reads the rows back, so the email is the only way a message reaches support ([Contact form](https://docs.snapfix.com/engineering-reference/api/help.md#contact-form)).
* The server's request log keeps the five fields, and the web sends them to Firebase Analytics before it checks the form ([Help API](https://docs.snapfix.com/engineering-reference/api/help.md#post-v1guesthelp-hub)).

### After sending

* iOS and Android show "Thank you for getting in touch! We have received your message and will get back to you shortly." and go back. The web shows a checkmark on the button for 1.5 seconds and clears the form, with no words; its button reads "Get In Touch" where the apps read "Submit" ([Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md#actions)).
* A failed send shows the API's message on all three platforms, or a generic message when there is none. On the web the form keeps its values. Android shows an alert with no text when the request gets no answer ([Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md#states)).

## Flow

```mermaid
flowchart TD
  signedin["Signed-in app user"] --> hub["Help Hub: GET IN TOUCH"]
  signedout["Signed-out user"] --> help["Help with logging in: Get in touch"]
  hub --> form["Get in touch form"]
  help --> form
  form --> valid{"Five fields filled in, email valid?"}
  valid -- "no" --> wait["Send button stays off"]
  valid -- "yes" --> online{"Apps: connected?"}
  online -- "no" --> offline["Connection alert, nothing sent"]
  online -- "yes" --> route{"Signed in, in the apps?"}
  route -- "yes" --> app["Signed-in route"]
  route -- "no, or on the web" --> guest["Guest route, shared login"]
  app --> stored["Row stored, one email to the support mailbox"]
  guest --> stored
  stored --> thanks["Apps: thank-you alert. Web: checkmark, form clears"]
  webmenu["Web side menu: Contact support"] --> center["Help center contact page, new tab"]
  maillink["App sign-in: Need help? Contact support"] --> mail["Mail app, to customersupport@"]
```

## Platforms

| Capability                  | Web                                                                                                                              | iOS                                                              | Android                                                 |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | ------------------------------------------------------- |
| Form, signed in             | No \[[ASK-195](https://github.com/snapfix/docs/blob/main/ASK.md#ask-195-should-signed-in-web-users-get-the-in-app-contact-form)] | Yes, the Help Hub's "GET IN TOUCH" tile                          | Yes, the Help Hub's "GET IN TOUCH" button               |
| Form, signed out            | Yes, "Get In Touch" on the sign-in help                                                                                          | Yes, the sign-in help's "GET IN TOUCH" footer                    | Yes, on the sign-in help screen                         |
| Route                       | Guest route                                                                                                                      | Signed-in or guest route, by sign-in state                       | Signed-in or guest route, by sign-in state              |
| Trims values before sending | No                                                                                                                               | Yes                                                              | No                                                      |
| Message of spaces only      | Sent, then refused                                                                                                               | Sent, then refused                                               | Button stays off                                        |
| After a successful send     | Checkmark for 1.5 seconds, form clears                                                                                           | Thank-you alert, then back                                       | Thank-you alert, then back                              |
| Offline                     | No check; the send fails with "Internal server error"                                                                            | Connection alert, nothing sent                                   | Connection alert, nothing sent                          |
| Analytics on send           | The five values                                                                                                                  | An event without values                                          | None                                                    |
| Help center contact page    | Side menu "Contact support"                                                                                                      | None reachable                                                   | My Profile "Contact Support", broken                    |
| Mail link to support        | None                                                                                                                             | "Need help? Contact support" on sign-in and some sign-up screens | The same, on sign-in, password and registration screens |

## Screens

* [Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md): the form, on all three platforms.
* [Help with logging in](https://docs.snapfix.com/how-the-apps-work/screens/help/login-help.md): the way to the form for signed-out users.
* [Help Hub](https://docs.snapfix.com/how-the-apps-work/screens/help/help-hub.md): the way to the form for signed-in app users, and the web's help center links.

## API and data

* [`POST /v1/app/help-hub`](https://docs.snapfix.com/engineering-reference/api/help.md#post-v1apphelp-hub): the form for a signed-in user, from iOS and Android.
* [`POST /v1/guest/help-hub`](https://docs.snapfix.com/engineering-reference/api/help.md#post-v1guesthelp-hub): the form for a signed-out user, from all three platforms.
* [Contact form](https://docs.snapfix.com/engineering-reference/api/help.md#contact-form): the five fields, the stored row and the email.
* Tables: [`tPri_Log_Helphub_ContactForm`](https://docs.snapfix.com/engineering-reference/db/tables/tpri_log_helphub_contactform.md), one row per message.
* The mail transport comes from the server's `MAIL_MAILER` setting, which is not in any repo \[[ASK-12](https://github.com/snapfix/docs/blob/main/ASK.md#ask-12-which-settings-do-the-production-api-servers-use)].

## Depends on

* [Help Hub](https://docs.snapfix.com/product/features/help/help-hub.md): the way in for signed-in app users.
* [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 carry the "HelpHub." link to the sign-in help and the "Need help?" mail link.
* The support mailboxes, the mail apps on the phone and the public help center, all outside these repos.
* Triggers: a stored row and an email to the support mailbox. No push, task, chat or HubSpot ticket.

## Edge cases

* **Offline:** iOS and Android check the connection and send nothing. The web does not check; the send fails and its alert says "Internal server error" ([Get in touch](https://docs.snapfix.com/how-the-apps-work/screens/help/get-in-touch.md#states)).
* **HubSpot token missing on the server:** every send fails with `500` before the message is stored.
* **Refused guest login on the web:** the web signs the visitor out and opens the sign-in page; the typed message is lost and nothing says it was not sent.
* **Message over 5,000 characters:** refused after the send; all three platforms show the API's message.
* **Request limit:** past 60 guest calls a minute or 1,000 a day from one address, the guest route answers `500` with "An unexpected error occurred. Please try again later.", not `429`.
* **Several sites, time zones and deleted items:** none. The routes check only the sign-in, not a site or a group.


---

# 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/contact-support.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.
