### Create CNAME Record (GoDaddy Example)

Source: https://docs.helpscout.com/article/666-dkim

This example shows the typical configuration for a CNAME record when using GoDaddy as the DNS hosting provider for Help Scout DKIM setup. It highlights the required fields.

```text
Type: CNAME
Name: strong1._domainkey.yourdomain.com
Value: strong1._domainkey.helpscout.net
```

--------------------------------

### GoDaddy CNAME Record Example

Source: https://docs.helpscout.com/article/42-setup-custom-domain

Example of how to set up a CNAME record in GoDaddy to point a subdomain to your Help Scout Docs site.

```text
Type: CNAME
Name: help.jgclothing.co
Value: jg-clothing.helpscoutdocs.com
```

--------------------------------

### Cloudflare CNAME Record Example

Source: https://docs.helpscout.com/article/42-setup-custom-domain

Example of how to set up a CNAME record in Cloudflare to point a subdomain to your Help Scout Docs site.

```text
Type: CNAME
Name: help
Target: jg-clothing.helpscoutdocs.com
```

--------------------------------

### Zendesk Explore Report Setup

Source: https://docs.helpscout.com/article/1596-find-contacts-served-in-other-platforms

Step-by-step instructions to configure a report in Zendesk Explore to count distinct end-users who had tickets created within a selected period. This involves selecting specific metrics and dimensions.

```text
1. Click the **Reports** icon in Explore
2. Click **New report** in the Reports library
3. Select **Support > Support - Tickets**
4. Click **Start report**
5. Add metrics
6. Select **Users and organizations > End-users**
7. Click **Apply**
8. Change the aggregator for the End-users metric to **D_COUNT**
9. Select **Time - Ticket Created > Ticket Created - Year and Time - Ticket Created - Month**
10. Click **Apply**
11. Filter results by selecting a period
```

--------------------------------

### Google Domains CNAME Record Example

Source: https://docs.helpscout.com/article/42-setup-custom-domain

Example of how to set up a CNAME record in Google Domains to point a subdomain to your Help Scout Docs site.

```text
Type: CNAME
Name: help
Data: jg-clothing.helpscoutdocs.com
```

--------------------------------

### GoDaddy CNAME Record Example

Source: https://docs.helpscout.com/article/666-use-dkim-to-help-with-email-delivery

An example demonstrating the CNAME record creation process on GoDaddy. It outlines the fields typically presented in GoDaddy's DNS management interface.

```GoDaddy
Type: CNAME
Name: _strong1._domainkey
Value: strong1._domainkey.helpscout.net
```

--------------------------------

### Markdown Basic Syntax Example

Source: https://docs.helpscout.com/article/1499-about-the-docs-editor

Illustrates basic Markdown syntax supported by the Docs editor for formatting text. This includes common elements like bold, italic, and lists, adhering to the basic Markdown specification.

```markdown
**Bold text**
*Italic text*
1. Numbered list item
* Bullet point
```

--------------------------------

### Install Beacon JavaScript Snippet

Source: https://docs.helpscout.com/article/1329-control-access-to-docs-using-beacon

This JavaScript code snippet is used to install the Help Scout Beacon on your website or application. It initializes the Beacon with specific configurations and should be placed in your site's HTML.

```javascript
 // Beacon installation code will be provided here from the Help Scout interface.
```

--------------------------------

### DKIM CNAME Record Example (GoDaddy)

Source: https://docs.helpscout.com/article/666-using-dkim-to-help-with-email-delivery

This example illustrates the configuration of a DKIM CNAME record in GoDaddy. It outlines the necessary fields for the record to correctly forward DKIM verification requests to Help Scout.

```text
Type: CNAME
Name: strong1._domainkey
Value: strong1._domainkey.helpscout.net
TTL: 1 Hour
```

--------------------------------

### Google Domains CNAME Record Example

Source: https://docs.helpscout.com/article/666-use-dkim-to-help-with-email-delivery

An example of how to create a CNAME record within the Google Domains interface. This shows the specific fields and expected input for a DKIM record.

```Google Domains
Type: CNAME
Name: _strong1._domainkey
Data: strong1._domainkey.helpscout.net
```

--------------------------------

### Example SPF Record Before Help Scout Removal

Source: https://docs.helpscout.com/article/58-spf-records

This example shows a typical SPF record that includes the Help Scout SPF entry, which can now be safely removed.

```text
v=spf1 include:_spf.google.com include:helpscoutemail.com ~all
```

--------------------------------

### Open Beacon to a Specific Screen

Source: https://docs.helpscout.com/article/1406-advanced-beacon-customization

This guide demonstrates how to use the `navigate` method in conjunction with the `open` method to direct users to a specific screen within the Beacon when a custom link is clicked. For example, opening directly to the 'Send a Message' screen.

```APIDOC
## Use navigate to Open Beacon to a Specific Screen

### Description
Allows opening the Beacon directly to a specific screen or route, such as the 'Send a Message' form. This is accomplished by chaining the `Beacon('open')` and `Beacon('navigate', '/route')` calls within an HTML link's `onclick` event.

### Method
HTML Link with JavaScript `onclick` event

### Endpoint
N/A (Client-side JavaScript)

### Parameters
#### None

### Request Example
```html
<a href="#" onclick="Beacon('open'); Beacon('navigate', '/ask/message')">Send us a Message</a>
```

### Response
#### Success Response (Beacon Opens to Specific Screen)
- N/A (The action triggers the Beacon UI to open at the specified route)

#### Response Example
N/A
```

--------------------------------

### Create CNAME Record (Google Domains Example)

Source: https://docs.helpscout.com/article/666-dkim

This example illustrates the format for creating a CNAME record in Google Domains for DKIM verification with Help Scout. It specifies the necessary 'name' and 'data' fields.

```text
Name: strong1._domainkey
Data: strong1._domainkey.helpscout.net
```

--------------------------------

### Create CNAME Record (Cloudflare Example)

Source: https://docs.helpscout.com/article/666-dkim

This example demonstrates how to configure a CNAME record within the Cloudflare DNS settings to facilitate Help Scout's DKIM verification process. It outlines the essential parameters.

```text
Type: CNAME
Name: strong1._domainkey
Target: strong1._domainkey.helpscout.net
```

--------------------------------

### Docs API for Knowledge Base Migration

Source: https://docs.helpscout.com/article/870-a-scouts-guide-to-switching-help-desks

The Docs API allows for custom data transfer of knowledge base articles from other providers to Help Scout. This is a DIY project requiring API coding knowledge.

```text
The Docs API is available to build a custom data transfer from other knowledge base providers. Keep in mind that this is a do-it-yourself project that will require API coding knowledge.
```

--------------------------------

### DKIM CNAME Record Example (Cloudflare)

Source: https://docs.helpscout.com/article/666-using-dkim-to-help-with-email-delivery

This example demonstrates how to set up a DKIM CNAME record in Cloudflare. It details the input format for name and target, ensuring the record directs DKIM checks to Help Scout.

```text
Type: CNAME
Name: strong1._domainkey
Target: strong1._domainkey.helpscout.net
Proxy status: DNS only
```

--------------------------------

### Example SPF Record After Help Scout Removal

Source: https://docs.helpscout.com/article/58-spf-records

This example shows the modified SPF record after removing the Help Scout specific entry, with Google's SPF entry remaining.

```text
v=spf1 include:_spf.google.com ~all
```

--------------------------------

### JavaScript Beacon Installation

Source: https://docs.helpscout.com/article/1356-add-beacon-to-your-website-or-app

This is the standard JavaScript code snippet required to install the Help Scout Beacon on a website or web-based application. It should be added to the site's code on pages where the Beacon is intended to appear. Note that the code should only be added once per page.

```javascript
This is the standard JavaScript code snippet required to install the Help Scout Beacon on a website or web-based application. It should be added to the site's code on pages where the Beacon is intended to appear. Note that the code should only be added once per page.
```

--------------------------------

### Create New Help Scout Conversation with Pre-filled Data (URL)

Source: https://docs.helpscout.com/article/119-pre-fill

This example demonstrates how to construct a URL to create a new Help Scout conversation with pre-filled customer name, email, Cc, Bcc, and subject line. All parameters are optional.

```URL
https://secure.helpscout.net/inboxes/[INBOX-SLUG]/conversation/new/?name=Thomas+Anderson&email=email@domain.com&cc=email2@domain.com&bcc=email3@domain.com,email4@domain.com&subject=help+scout+is+the+best
```

```URL
https://secure.helpscout.net/inboxes/[INBOX-SLUG]/conversation/new/?email=email@domain.com
```

--------------------------------

### Populate Customer Properties with Beacon Identify

Source: https://docs.helpscout.com/article/1385-customer-properties

This example demonstrates how to use the Beacon identify method to sync customer data, including built-in profile fields like name and email, and custom properties such as 'planName' and 'billing-frequency', to a customer's profile.

```javascript
Beacon('identify', {
  email: 'customer@example.com',
  name: 'Jane Doe',
  // Custom properties
  planName: 'Pro',
  'billing-frequency': 'monthly'
});
```

--------------------------------

### User Pronouns Variable Example

Source: https://docs.helpscout.com/article/468-variables

Illustrates using a variable to display user pronouns in an inbox signature. The example shows how to include the variable `{%user.pronouns%}` and add surrounding characters for formatting.

```text
{%user.pronouns%}
```

--------------------------------

### Using Identify Method with Customer Properties (JavaScript)

Source: https://docs.helpscout.com/article/1477-messages-marketing-teams__ga=2.219214873.1893971808.1662984892-999783069

This JavaScript snippet demonstrates how to use the Identify method from the Beacon JavaScript API to pass customer properties. This allows for audience selection to identify existing customers or tailor experiences based on user data.

```javascript
Beacon('identify', {
  customer_id: '123',
  email: 'customer@example.com',
  name: 'Jane Doe',
  // Add any other relevant customer properties
  company: 'Acme Corp',
  plan_type: 'premium'
});
```

--------------------------------

### Help Scout Advanced Search Combination Example

Source: https://docs.helpscout.com/article/47-search-filters-with-operators

Illustrates how to combine multiple search filters and operators (AND, OR, NOT) for precise searches, such as filtering by subject, assignee, and tags.

```text
_subject:(coffee OR tea) assigned:Josie Gato tag:carrots_
tag:carrots OR assigned:Josie Gato
tag:carrots NOT assigned:Josie Gato_
```

--------------------------------

### FollowUpThen Reminder Example

Source: https://docs.helpscout.com/article/256-follow-up-then

Add a FollowUpThen email address to the BCC field to set a reminder. The format `Xd@followupthen.com` will trigger a reminder in X days.

```email
Bcc: 2d@followupthen.com
```

--------------------------------

### DKIM CNAME Record Example (Google Domains)

Source: https://docs.helpscout.com/article/666-using-dkim-to-help-with-email-delivery

This example shows how to configure a DKIM CNAME record in Google Domains. It specifies the name and value required for the record to point to Help Scout's servers for DKIM verification.

```text
Name: strong1._domainkey
Type: CNAME
TTL: 3600
Value: strong1._domainkey.helpscout.net
```

--------------------------------

### Help Scout Timeframe Filters Examples

Source: https://docs.helpscout.com/article/47-search-filters-with-operators

Demonstrates the syntax for using timeframe filters like 'after', 'before', 'between', and 'on' to search for conversations based on their closing or waiting dates.

```text
after:2020-01-25
before:2019-12-31
between:2020-07-06&2020-07-10
on:2020-02-05
```

--------------------------------

### DNS Lookup for CNAME Record

Source: https://docs.helpscout.com/article/666-dkim

This example shows how to use a DNS lookup tool like MX Toolbox to verify a CNAME record's configuration. It checks if the specified domain correctly points to the Help Scout CNAME target.

```text
Query: strong1._domainkey.yourdomain.com
Expected Result: Canonical Name: strong1._domainkey.helpscout.net
```

--------------------------------

### Interpreting a 'No Mail Hosts for Domain' Bounce Error

Source: https://docs.helpscout.com/article/1442-troubleshooting-conversations-in-needs-attention-and-bounces

This example shows a specific bounce error message and explains its meaning: the recipient's domain does not exist. It guides the user to check and correct the recipient's email address.

```text
unable to route: no mail hosts for domain

recipient email address: _pjudge@shirtsandstuff.net_
actual domain: shirtsandstuff.xyz
```

--------------------------------

### Structure Definition Lists in HTML

Source: https://docs.helpscout.com/article/1501-use-html-in-the-docs-editor

An example of using HTML definition lists (<dl>) with terms (<dt>) and descriptions (<dd>) to create step-by-step instructions. This structure helps in organizing detailed procedural content.

```html
<dl>
	<dt>1</dt>
		<dd>Go to the Winchester.</dd>
	<dt>2</dt>
		<dd>Have a nice cold pint.</dd>
	<dt>3</dt>
		<dd>Wait for this to all blow over.</dd>
</dl>
```

--------------------------------

### Formatting Variables in Help Scout Templates

Source: https://docs.helpscout.com/article/468-work-with-variables

Illustrates how to add characters like parentheses around variables in Help Scout templates to format the output, for example, user pronouns.

```Liquid
({%user.pronouns%})
```

--------------------------------

### Keyboard Shortcuts for Formatting

Source: https://docs.helpscout.com/article/1499-about-the-docs-editor

Provides essential keyboard shortcuts for common text formatting actions within the Docs editor, applicable to both Mac (Cmd) and Windows (Ctrl) operating systems. These shortcuts enhance editing efficiency.

```text
Bold: Cmd + B / Ctrl + B
Italic: Cmd + I / Ctrl + I
Underline: Cmd + U / Ctrl + U
Create Link: Cmd + K / Ctrl + K
```

--------------------------------

### Embed Kapwing Video in HTML

Source: https://docs.helpscout.com/article/1501-use-html-in-the-docs-editor

Example of an embed code for a video hosted on Kapwing, to be used within an HTML block. This code includes iframe attributes for video playback and styling for display.

```html
<div style="height: 533.39px; width: 300.00px; position:relative;"><iframe allow="autoplay; gyroscope;" allowfullscreen height="100%" referrerpolicy="strict-origin" src="https://www.kapwing.com/e/646e7619dfa8110017d3545445642fbf" style="border:0; height:100%; left:0; overflow:hidden; position:absolute; top:0; width:100%" title="Embedded content made on Kapwing" width="100%"></iframe></div><p style="font-size: 12px; text-align: right;">Video edited on <a href="https://www.kapwing.com/video-editor">Kapwing</a></p>
```

--------------------------------

### Add DKIM CNAME Records (Cloudflare)

Source: https://docs.helpscout.com/article/1400-create-cname-records-at-cloudflare-to-work-with-help-scout__ga=2.98692695.874064473.1627997538-1024939178

Creates two CNAME records required for DKIM setup with Help Scout. These records help improve email deliverability. Ensure the 'Proxy status' is set to 'DNS only'.

```Cloudflare DNS Configuration
Type: CNAME
Name: strong1._domainkey
Target: strong1._domainkey.helpscout.net
TTL: Auto
Proxy status: DNS only
```

```Cloudflare DNS Configuration
Type: CNAME
Name: strong2._domainkey
Target: strong2._domainkey.helpscout.net
TTL: Auto
Proxy status: DNS only
```

--------------------------------

### Markdown Formatting Examples

Source: https://docs.helpscout.com/article/1506-whats-new-with-the-conversation-editor

Demonstrates how to use Markdown syntax within the Help Scout conversation editor for text formatting. This includes bold, italic, strikethrough, code snippets, blockquotes, numbered lists, and bulleted lists.

```markdown
**your text**
*your text*
~your text~
`your text`
> your blockquote
1. your text
  
- your text
  
```

--------------------------------

### Open Docs articles in Help Scout Beacon using JavaScript API

Source: https://docs.helpscout.com/article/1282-move-from-intercom

This code example shows how to programmatically open a specific Help Scout Docs article within the Beacon interface using the JavaScript API's 'article' method. This is useful for linking directly to relevant help content from your website or application.

```javascript
Beacon("article", "ARTICLE_ID_OR_SLUG");
```

--------------------------------

### Cloudflare CNAME Record Example

Source: https://docs.helpscout.com/article/666-use-dkim-to-help-with-email-delivery

This snippet illustrates how to configure a CNAME record within Cloudflare's DNS settings. It highlights the fields relevant for adding external DNS records.

```Cloudflare
Type: CNAME
Name: _strong1._domainkey
Target: strong1._domainkey.helpscout.net
```

--------------------------------

### Example Bounce Error in Help Scout

Source: https://docs.helpscout.com/article/1442-troubleshooting-conversations-in-needs-attention-and-bounces

This snippet demonstrates the appearance of a bounce error message within a Help Scout conversation, including the 'View details' link that reveals the specific error from the recipient's server.

```text
This email could not be delivered

View details
```

--------------------------------

### Link Social Media Icons in Help Scout Signature (HTML)

Source: https://docs.helpscout.com/article/547-create-and-manage-mailbox-signatures

This example demonstrates how to link a social media icon to a company's page using an HTML `<a>` tag enclosing an `<img>` tag. Replace the placeholder URLs with your actual image hosting URL and social media page URL.

```html
<a href="https://facebook.com/julesandgeorge"><img src="https://yourimagespace.com/images/facebookicon.png" alt="Logo"></a>
```

--------------------------------

### Disable Beacon Notification Sounds

Source: https://docs.helpscout.com/article/1406-advanced-beacon-customization

This script disables all notification sounds for the Helpscout Beacon. It should be added after the initial Beacon installation code or incorporated into an existing Beacon config call.

```javascript
<script>Beacon('config', { enableSounds: false })</script>
```

--------------------------------

### HTML Divider Tag

Source: https://docs.helpscout.com/article/1499-about-the-docs-editor

Demonstrates the use of the HTML <hr> tag to insert a horizontal rule, which functions as a divider within the Docs editor. This is a standard HTML element for visual separation.

```html
<hr>
```

--------------------------------

### Open Edge Notifications Settings

Source: https://docs.helpscout.com/article/1227-about-chat-notifications

This code snippet provides the URL to access notification settings directly within the Microsoft Edge browser. It allows users to add Help Scout to their allow list for sending notifications.

```plaintext
edge://settings/content/notifications
```

--------------------------------

### Embed Beacon Code in Wix

Source: https://docs.helpscout.com/article/1348-add-beacon-to-a-wix-site

This snippet shows how to add the Beacon installation code to the 'Body - End' section of your Wix website via the Custom Code feature. Ensure your Wix site is on a paid plan to access this functionality. The code should be pasted into the provided box, named appropriately, and applied to the desired pages.

```html
<script src="YOUR_BEACON_EMBED_CODE"></script>
```

--------------------------------

### Disable Beacon Pulse Animation

Source: https://docs.helpscout.com/article/1406-advanced-beacon-customization

This code snippet disables the initial pulse animation of the Help Scout Beacon button. It should be added after the Beacon installation code or incorporated into an existing Beacon config call. The 'enableFabAnimation' configuration option is set to 'false' to turn off the animation.

```javascript
<script>Beacon('config', {enableFabAnimation:false} );</script>
```

--------------------------------

### Initialize and Show Message with Force Option (JavaScript)

Source: https://docs.helpscout.com/article/1345-messages-actions-events-and-audience

This snippet demonstrates how to manually initialize and display a Helpscout message using the Beacon JavaScript API. The `force: true` option ensures the message appears every time the page is loaded, overriding other audience or event settings.

```javascript
<script>
Beacon('show-message', 'MESSAGE_ID', { force: true })
</script>
```

--------------------------------

### Basic Variable Usage in Help Scout

Source: https://docs.helpscout.com/article/468-work-with-variables

Demonstrates the standard syntax for using variables in Help Scout templates, such as inserting a customer's first name.

```Liquid
{%customer.firstName%}
```

--------------------------------

### Help Scout Specific Documentation Links

Source: https://docs.helpscout.com/article/1140-mailbox-api

Provides direct links to key sections of the Help Scout Developer documentation, covering authentication, status codes, endpoints, change logs, rate limits, webhooks, apps, open-source tools, Docs API, and Beacon customizations.

```APIDOC
## Links to Specific Help Scout Documentation

### Description
This section provides direct links to essential parts of the Help Scout Developer documentation for various functionalities and resources.

### Documentation Sections

*   **Developer Documentation Hub:** [https://developer.helpscout.com/](https://developer.helpscout.com/)
*   **Inbox API:** [https://developer.helpscout.com/mailbox-api/](https://developer.helpscout.com/mailbox-api/)
*   **Authentication:** [https://developer.helpscout.com/overview/authentication/](https://developer.helpscout.com/overview/authentication/)
*   **Status Codes:** [https://developer.helpscout.com/overview/status-codes/](https://developer.helpscout.com/overview/status-codes/)
*   **Endpoints:** [https://developer.helpscout.com/endpoints/](https://developer.helpscout.com/endpoints/)
*   **Change Log:** [https://developer.helpscout.com/changelog/](https://developer.helpscout.com/changelog/)
*   **Rate Limits:** [https://developer.helpscout.com/overview/rate-limits/](https://developer.helpscout.com/overview/rate-limits/)
*   **Webhooks:** [https://developer.helpscout.com/webhooks/](https://developer.helpscout.com/webhooks/)
*   **Apps:** [https://developer.helpscout.com/apps/](https://developer.helpscout.com/apps/)
*   **Open Source Tools:** [https://developer.helpscout.com/open-source/](https://developer.helpscout.com/open-source/)
*   **Docs API:** [https://developer.helpscout.com/docs-api/](https://developer.helpscout.com/docs-api/)
*   **Beacon Customizations (JavaScript):** [https://developer.helpscout.com/beacon-api/customizations/javascript/](https://developer.helpscout.com/beacon-api/customizations/javascript/)
*   **Beacon Customizations (Mobile SDKs):** [https://developer.helpscout.com/beacon-api/customizations/mobile-sdks/](https://developer.helpscout.com/beacon-api/customizations/mobile-sdks/)
```

--------------------------------

### Markdown Formatting for Saved Replies

Source: https://docs.helpscout.com/article/18-create-saved-replies-for-fast-answers

Demonstrates the Markdown syntax supported by Help Scout for styling text within saved replies, including bold, italics, strikethrough, code, blockquotes, and ordered/unordered lists. No external dependencies are required, as this is a client-side feature.

```Markdown
**your text**
```

```Markdown
*your text*
```

```Markdown
~your text~
```

```Markdown
`your text`
```

```Markdown
> your blockquote
```

```Markdown
1. your text
```

```Markdown
- your text
```

--------------------------------

### Pre-fill Subject for New Help Scout Conversations

Source: https://docs.helpscout.com/article/833-help-scout-hack-pack

This snippet demonstrates how to construct a URL to create a new Help Scout conversation with a pre-filled subject line. It requires replacing '[INBOX-SLUG]' with the specific inbox identifier. This is useful for creating bookmarked quick-start links.

```text
https://secure.helpscout.net/mailbox/[INBOX-SLUG]/new-ticket/?subject=Help+Scout+is+the+best
```

--------------------------------

### Convert X.509 Certificate to PEM Format

Source: https://docs.helpscout.com/article/880-generic-identity-provider

This command converts an X.509 certificate from CRT format to PEM format, which is required for uploading to Help Scout if the initial upload fails due to format issues.

```bash
openssl x509 -in idpcertificate.crt -out convertedcertificate.pem -outform PEM
```

--------------------------------

### Set Reminders using FollowUpThen Email

Source: https://docs.helpscout.com/article/833-help-scout-hack-pack

This explains how to use the FollowUpThen service to set reminders for conversations within Help Scout. By including a FollowUpThen email address in the Cc or Bcc fields of a reply, users can schedule reminders.

```Email
Cc or Bcc: _5minutes@followupthen.com_
```

--------------------------------

### Help Scout Search: Basic Operators

Source: https://docs.helpscout.com/article/47-search-operators

Demonstrates basic Help Scout search operators for phrase matching, boolean logic, and wildcards. These operators can be combined with specific filters to refine search queries effectively.

```Search Query
"exact phrase"
```

```Search Query
term1 AND term2
```

```Search Query
term1 OR term2
```

```Search Query
term1 NOT term2
```

```Search Query
term*
```

--------------------------------

### Beacon JavaScript API for Customization

Source: https://docs.helpscout.com/article/1356-add-beacon-to-your-website-or-app

This section refers to the Beacon JavaScript API, which allows for advanced customization of the Beacon's behavior on websites or web-based apps. Developers can use this API to control when and how the Beacon appears, pass customer information, or open specific Beacon features.

```javascript
You can use your own JavaScript to customize how, when, and where you call the Beacon, pass along customer information, use it to automatically open Beacon to a specific screen, or even open Docs articles in a sidebar or modal window, as just a few examples of the things you can do.
```

--------------------------------

### Help Scout API Access Levels and Rate Limits

Source: https://docs.helpscout.com/article/1140-mailbox-api

Details on API access levels and rate limits for different Help Scout plans (Standard, Plus, Pro). The Free plan does not include API access.

```APIDOC
## Help Scout API Access

### Description
This section outlines the API access levels and rate limits associated with different Help Scout plans.

### Plan Comparison

| Plan      | Rate Limit             | Endpoint Access              |
|-----------|------------------------|------------------------------|
| Standard  | Up to 200 calls/minute | No access to reporting endpoints |
| Plus      | Up to 400 calls/minute | All endpoints available      |
| Pro       | Up to 800 calls/minute | All endpoints available      |

**Note:** The Free plan does not include access to the API or integrations.
```

--------------------------------

### Basic Search Operators

Source: https://docs.helpscout.com/article/47-search-filters-with-operators

Demonstrates basic search conventions for finding data in Help Scout. Includes using quotes for exact phrases, Boolean operators (AND, OR, NOT), and wildcards for partial matches. Wildcards at the beginning of a term may require specific filters for efficiency.

```Help Scout Search Syntax
"exact phrase"
AND, OR, NOT
*wildcard
```

--------------------------------

### Keyboard Shortcuts for Styling Text

Source: https://docs.helpscout.com/article/18-create-saved-replies-for-fast-answers

Provides a list of keyboard shortcuts for applying common text formatting styles (bold, italic, underline, lists, links) within the Help Scout saved reply editor. These shortcuts are designed for quick, in-line editing.

```Keyboard Shortcuts
Cmd + B
```

```Keyboard Shortcuts
Cmd + I
```

```Keyboard Shortcuts
Cmd + U
```

```Keyboard Shortcuts
Cmd + Shift + 8
```

```Keyboard Shortcuts
Cmd + Shift + 7
```

```Keyboard Shortcuts
Cmd + K
```

--------------------------------

### Greet Customers by First Name - Help Scout Messages

Source: https://docs.helpscout.com/article/1466-style-your-message

Personalize messages by using the `customer.firstName` variable. This snippet demonstrates how to implement a fallback name when the customer's first name is unknown.

```javascript
// Example of using the customer.firstName variable with a fallback
// When the message appears, if the customer is identified and their first name is known, it will display their name.
// If the first name is unknown, it will display the fallback text.
// Usage: (customer.firstName, fallback=there)
// For a customer named Rashida: "Hello Rashida."
// For an unknown customer: "Hello there."
```

--------------------------------

### Add Custom Docs Domain CNAME (Cloudflare)

Source: https://docs.helpscout.com/article/1400-create-cname-records-at-cloudflare-to-work-with-help-scout__ga=2.98692695.874064473.1627997538-1024939178

Sets up a CNAME record for a custom domain used with Help Scout Docs. The 'Name' field uses the subdomain of your custom domain, and the 'Target' is your Help Scout Docs subdomain. The record must be set to 'DNS only'.

```Cloudflare DNS Configuration
Type: CNAME
Name: [Your Custom Subdomain]
Target: [Your Help Scout Docs Subdomain]
TTL: Auto
Proxy status: DNS only
```

--------------------------------

### Variable Usage with Fallback Attribute

Source: https://docs.helpscout.com/article/468-work-with-variables

Shows how to use the fallback attribute with variables to provide default text when specific data is not available, like a customer's first name.

```Liquid
{%customer.firstName,fallback=there%}
```

--------------------------------

### Troubleshooting CNAME Record Verification

Source: https://docs.helpscout.com/article/666-use-dkim-to-help-with-email-delivery

Instructions for verifying DKIM CNAME records using MX Toolbox. It specifies the input for the lookup and the expected 'Canonical Name' result to confirm correct configuration.

```MX Toolbox
Lookup for: strong1._domainkey.yourdomain.com
Expected Canonical Name: strong1._domainkey.helpscout.net
```

--------------------------------

### CSP Level 1/2 Directives for Beacon

Source: https://docs.helpscout.com/article/815-csp-settings-for-beacon

This section provides the required CSP directives for Beacon to function on websites using CSP levels 1 or 2. It lists specific sources for various policy types like connect-src, child-src, style-src, etc.

```http
connect-src:
    https://beaconapi.helpscout.net
    https://chatapi.helpscout.net
    https://d3hb14vkzrxvla.cloudfront.net
    wss://*.pusher.com 
child-src: // only needed if your Docs content includes any of the video sources below
    https://www.youtube.com
    https://player.vimeo.com
    https://fast.wistia.net
    https://www.loom.com
    https://share.getcloudapp.com
style-src:
    'unsafe-inline'
    https://fonts.googleapis.com
    https://beacon-v2.helpscout.net
font-src:
    data:
    https://fonts.gstatic.com
    https://beacon-v2.helpscout.net
base-uri:
    https://docs.helpscout.net
script-src:
    'unsafe-inline'
    https://beacon-v2.helpscout.net
frame-src:
    https://beacon-v2.helpscout.net
object-src:
    https://beacon-v2.helpscout.net
img-src:
    https://*.gravatar.com
    https://beacon-v2.helpscout.net
    https://d33v4339jhl8k0.cloudfront.net
    https://chatapi-prod.s3.amazonaws.com/
media-src:
    https://beacon-v2.helpscout.net
```

--------------------------------

### Format Text with Markdown - Help Scout Messages

Source: https://docs.helpscout.com/article/1466-style-your-message

Learn how to apply formatting like bold, italic, underline, strikethrough, links, blockquotes, code snippets, bulleted lists, and numbered lists using Markdown syntax or keyboard shortcuts within Help Scout Messages.

```markdown
**Bold**
Wrap your text in `******`, or highlight the text and press `Cmd+B` (`Ctrl+B` on Windows) on your keyboard
**Italic**
Wrap your text in `*****`, or highlight the text and press `Cmd+I` (`Ctrl+I` on Windows)
**Underline**
Wrap your text in `++`, or highlight the text and press `Cmd+U` (`Ctrl+U` on Windows)
**Strikethrough**
Wrap your text in `~` (tilde), or highlight the text and press `Option+Cmd+S` (`Alt+Ctrl+S` on Windows)
**Link Text**
Wrap your text in brackets and then follow it immediately with the URL in parentheses. For example, `[The Help Scout Blog](https://www.helpscout.com/blog/)` would give you The Help Scout Blog. Or highlight the text and use the `Cmd+K` (`Ctrl+K` on Windows) keyboard shortcut.
**Blockquote**
Start a line with `>` (the greater than symbol) to set quoted text, or use the shortcut menu option **Blockquote**.
**Code**
Wrap your text in ` ` ` (backtick) for inline code snippets, or choose **Code** from the shortcut menu to use a code block.
**Bulleted List**
Type `-` or `*` to start a bulleted list or choose **Bulleted list** in the shortcut menu.
**Numbered list**
Type `1.` to start a numbered list or choose **Numbered list** in the shortcut menu.
```

--------------------------------

### Help Scout Notification Commands Overview

Source: https://docs.helpscout.com/article/43-email-commands

This snippet summarizes the commands used in Help Scout for interacting with customer notifications. Each command has a specific function, such as sending replies, adding internal notes, assigning users, or managing tags and recipients. Some commands have specific usage requirements, like '@note' needing to be followed immediately by note content.

```text
Command | Values
---|---
<text> | text with no command is sent as a reply to the customer
@note | notes are visible only to other Help Scout Users
@assign | first/full name of another user, email address of another user, full name of a Team (requires the Teams feature)
@me | no value required, assigns to yourself
@status | active, pending, closed, spam
@active, @pending, @closed, @spam | no value required, sets the status accordingly
@tag | add one or more tags, each separated by a comma
@cc | any valid email address, separate multiple with commas (note: should not be used alongside @note)
@bcc | any valid email address, separate multiple with commas
@subject | whatever you want the new subject to be
@nocc | Help Scout is "Reply All" by default, but you can use this command to remove any Cc'd parties on the reply.
@nobcc | If auto bcc is enabled in your user profile, use this command to prevent it from applying to a specific message.
```

--------------------------------

### Troubleshooting DKIM Verification with MX Toolbox

Source: https://docs.helpscout.com/article/666-using-dkim-to-help-with-email-delivery

This snippet describes how to use MX Toolbox to verify DKIM CNAME records. It explains what the expected 'Canonical Name' result should be when checking the `strong1._domainkey.yourdomain.com` record.

```text
Lookup `strong1._domainkey.yourdomain.com`
Expected Canonical Name: `strong1._domainkey.helpscout.net`
```

--------------------------------

### Help Scout Custom Docs Domain CNAME (Cloudflare)

Source: https://docs.helpscout.com/article/1400-create-cname-records-at-cloudflare-to-work-with-help-scout

Sets up a CNAME record in Cloudflare to use a custom domain for Help Scout Docs. The 'Name' is the subdomain of your custom domain, and the 'Target' is your Help Scout Docs subdomain.

```Cloudflare DNS Configuration
Type: CNAME
Name: [your_subdomain]
Target: [your_helpscout_docs_subdomain].helpscout.net
TTL: Auto
Proxy status: DNS only
```

--------------------------------

### Apply Responsive Classes to Video Embeds

Source: https://docs.helpscout.com/article/1501-use-html-in-the-docs-editor

Demonstrates how to wrap a video embed code with a section that has 'video' and 'widescreen' classes. This is used to ensure videos display correctly across different screen sizes.

```html
<section class="video widescreen"> VIDEO EMBED CODE GOES HERE </section>
```

--------------------------------

### Set Custom Article Suggestions with Beacon JavaScript

Source: https://docs.helpscout.com/article/1264-content-suggestions-by-url

This snippet demonstrates how to use the Beacon JavaScript API to set custom suggested articles or links. It requires the Beacon JavaScript to be included on your page. The `Beacon('suggest', suggestions)` method is used to apply the suggestions.

```javascript
Beacon('suggest', [
  { 'title': 'How to set up suggestions', 'url': 'https://docs.example.com/setup' },
  { 'title': 'Linking to external sites', 'url': 'https://www.external-example.com' }
]);
```

--------------------------------

### Set Custom Content Suggestions with Beacon JavaScript

Source: https://docs.helpscout.com/article/1264-customize-content-suggestions-in-beacon

Use the Beacon JavaScript API to programmatically set suggested articles or links based on custom criteria. This allows for dynamic content delivery tailored to user behavior or specific page contexts. The `Beacon('suggest', suggestions)` method is used for this purpose.

```javascript
Beacon('suggest', [
  {
    "type": "doc",
    "id": "article_id_1"
  },
  {
    "type": "web",
    "url": "https://www.example.com",
    "text": "Visit our website"
  }
]);
```

--------------------------------

### Basic Search Operators

Source: https://docs.helpscout.com/article/47-search-filters-with-operators__ga=2.232625503.175449886.1652186376-1024939178

Demonstrates the use of standard search operators for exact phrase matching, boolean logic, and partial matching. These operators enhance the precision of full-text searches.

```text
Search for an exact phrase:
"help scout"

Use Boolean operators:
(support OR sales) AND urgent
(invoices OR billing) NOT paid

Use a wildcard for partial matches:
subject:cust*
```

--------------------------------

### CSP Strict Level 3 Configuration for Beacon

Source: https://docs.helpscout.com/article/815-csp-settings-for-beacon

This snippet shows the Content Security Policy header configuration for strict CSP level 3, including the 'nonce-{random}' attribute for script tags to enable Beacon.

```nginx
Content-Security-Policy:
    object-src 'none';
    script-src 'nonce-{random}' 'unsafe-inline' 'unsafe-eval' 'strict-dynamic' https: http:;
    base-uri 'none';
    report-uri https://your-report-collector.example.com
```

--------------------------------

### Trigger Workflow from Beacon Notes Contain Condition

Source: https://docs.helpscout.com/article/833-help-scout-hack-pack

This snippet shows how to set up a workflow condition in Help Scout to trigger actions based on text contained within the notes of conversations originating from a specific Beacon. It demonstrates using the 'Notes Contain' condition to filter conversations.

```Help Scout Workflow
Body > Notes Contain
Add text from the note that Beacon leaves for your condition. For example, if you wanted to catch every conversation that came from your Beacon named _Sales Beacon_ , it would look like this:
"Sales Beacon"
```

--------------------------------

### Custom Button or Link to Open Beacon

Source: https://docs.helpscout.com/article/1406-advanced-beacon-customization

This section explains how to create a custom button or link to trigger the opening of the Help Scout Beacon. It involves hiding the default button in Beacon settings and using a specific HTML link with an onclick event to call the Beacon('open') method.

```APIDOC
## Use a Custom Button or Link to Open Beacon

### Description
Create a custom menu item or button that visitors can click to open the Beacon, rather than having it open automatically. This is achieved by hiding the default Beacon button in the settings and using a provided HTML link that calls the `Beacon('open')` method.

### Method
HTML Link with JavaScript `onclick` event

### Endpoint
N/A (Client-side JavaScript)

### Parameters
#### None

### Request Example
```html
<a href="#" onclick="Beacon('open');">LINK TEXT or IMG SRC HERE</a>
```

### Response
#### Success Response (Beacon Opens)
- N/A (The action triggers the Beacon UI)

#### Response Example
N/A
```

--------------------------------

### Help Scout Conversation URL Format

Source: https://docs.helpscout.com/article/11-understand-conversation-icons-and-colors

This is the standard format for a Help Scout conversation URL. It includes a unique conversation ID and a conversation number for referencing specific discussions.

```text
https://secure.helpscout.net/conversation/{conversationId}/{conversationNumber}
```

--------------------------------

### Open Beacon to a Specific Screen

Source: https://docs.helpscout.com/article/1406-advanced-beacon-customization

This code snippet shows how to open the Help Scout Beacon to a specific screen, such as the 'Send a Message' screen. It uses the 'Beacon('open');' method combined with the 'Beacon('navigate', '/ask/message')' method to direct the user to the desired route within the Beacon. This is useful for call-to-action links.

```html
<a href="#" onclick="Beacon('open'); Beacon('navigate', '/ask/message')">Send us a Message</a>
```

--------------------------------

### Regex for ACS URL Validation in OneLogin

Source: https://docs.helpscout.com/article/879-enabling-sso-with-onelogin-as-the-identity-provider

This regular expression is used in OneLogin to validate the Assertion Consumer Service (ACS) URL for the Help Scout SAML application. It ensures that the URL conforms to a standard format.

```regex
[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&//=]*)
```

--------------------------------

### Shopify: Embed Help Scout Beacon in header.liquid

Source: https://docs.helpscout.com/article/1351-add-beacon-to-a-shopify-site

This snippet shows where to paste the Help Scout Beacon embed code within the `header.liquid` file of a Shopify theme. It should be placed directly above the `{% schema %}` tag. Ensure correct placement to avoid errors.

```liquid
// Paste your Help Scout Beacon embed code here
{% comment %}
  Example Beacon embed code:
  <script src="https://beacon.helpscout.net/embed.js" data-options='{"host":"https://docs.helpscout.com"}' async="true"></script>
{% endcomment %}

{% schema %}
  // Existing Shopify theme schema
{% endschema %}
```

--------------------------------

### CSS for Retina-Friendly Logo

Source: https://docs.helpscout.com/article/79-retina-logo

This CSS code snippet is used to display a logo as a background image, ensuring it appears crisp on high-resolution (retina) displays. It requires replacing 'XXpx' with the desired dimensions and 'path/to/image' with the actual image URL. The `background-size: 100%;` property helps scale the image appropriately.

```css
#mainNav .brand span {
	display: inline-block;
	text-indent: -9000px;
	width: XXpx;
	height: XXpx;
	background: url(path/to/image) no-repeat 0 0;
	background-size: 100%;
}
```

--------------------------------

### Help Scout Advanced Search Operators

Source: https://docs.helpscout.com/article/47-search-filters-with-operators__ga=2.232625503.175449886.1652186376-1024939178

Illustrates how to combine multiple search filters using logical operators like OR and NOT for more precise search results. Default behavior uses AND.

```Help Scout Search Syntax
subject:(coffee OR tea) assigned:Josie Gato tag:carrots
```

```Help Scout Search Syntax
tag:carrots OR assigned:Josie Gato
```

```Help Scout Search Syntax
tag:carrots NOT assigned:Josie Gato
```

--------------------------------

### Help Scout Search: Customer Filter

Source: https://docs.helpscout.com/article/47-search-operators

Filters conversations based on customer names. Allows searching for exact customer names, exact phrases, or partial matches.

```Search Query
customer:Eliot
```

```Search Query
customer:"Eliot Rosewater"
```

--------------------------------

### Sending Customer Replies in Help Scout

Source: https://docs.helpscout.com/article/67-respond-to-email-notifications-to-take-action-in-help-scout

Any text entered without a command is sent as a reply directly to the customer. This text is visible to the customer.

```text
Thank you for your message. We will get back to you shortly.
```

--------------------------------

### DKIM CNAME Record Format

Source: https://docs.helpscout.com/article/666-use-dkim-to-help-with-email-delivery

This snippet illustrates the required format for DKIM CNAME records. The 'Name/Host' field should contain the specific subdomain and your domain, while the 'Value/Target' field points to the corresponding Help Scout domain.

```DNS
Name/Host: strong1._domainkey.yourdomain.com
Value/Target: strong1._domainkey.helpscout.net
```

```DNS
Name/Host: strong2._domainkey.yourdomain.com
Value/Target: strong2._domainkey.helpscout.net
```

--------------------------------

### Help Scout Custom Search URL Construction

Source: https://docs.helpscout.com/article/47-search-filters-with-operators

Provides the base URL structure for creating custom search queries in Help Scout, showing how to append search terms.

```text
https://secure.helpscout.net/search/?query=search+term
```

--------------------------------

### Log custom fields to Help Scout sidebar using Beacon JavaScript API

Source: https://docs.helpscout.com/article/1282-move-from-intercom

This snippet demonstrates how to log custom user data, such as 'role' or 'plan', to the Help Scout sidebar using the Beacon JavaScript API's 'identify' method. It's essential for enriching customer context within the sidebar. Secure Mode should be enabled for secure data handling.

```javascript
Beacon("identify", {
  email: "customer@example.com",
  name: "Customer Name",
  customFields: {
    role: "Pro",
    plan: "Premium"
  }
});
```

--------------------------------

### Enable Image Lightbox with 'lightbox' Class - HTML

Source: https://docs.helpscout.com/article/1501-use-html-in-the-docs-editor

Adds a 'lightbox' class to an image link to allow users to click the image and view it in its full size. Images are automatically resized by Docs. Recommended to use with `<figure>` and `<figcaption>` for captions.

```html
<figure>
<a href="https://yourfilelocation.com/image.png" class="lightbox">
<img src="https://yourfilelocation.com/image.png" alt="">
</a>
<figcaption>Click to see a larger version</figcaption>
</figure>
```

--------------------------------

### Specialize Auto Replies with Workflow Conditions

Source: https://docs.helpscout.com/article/833-help-scout-hack-pack

This demonstrates how to customize auto-replies in Help Scout using workflows. It involves disabling the default auto-reply and creating a workflow with specific conditions (e.g., excluding email addresses or differentiating based on contact source) and the 'Send Email to the Customer' action.

```Help Scout Workflow
Action: _Send Email to the Customer_
```

--------------------------------

### Reset Help Scout Tags Local Storage (JavaScript)

Source: https://docs.helpscout.com/article/13-create-and-manage-tags

This JavaScript snippet is designed to be run in a browser's developer console within a Help Scout conversation. It clears the 'Tags-List' key from local storage, which helps resolve issues with recently added tags not appearing or being searchable. Ensure you are within a conversation context for the command to function correctly.

```javascript
HS.Utils.LocalStorage.deleteKey('Tags-List');

```

--------------------------------

### Embed Help Scout Articles in Various Formats (HTML)

Source: https://docs.helpscout.com/article/1353-beacon-embedded-articles

These HTML snippets demonstrate how to embed Help Scout articles using different data attributes to control their display. Each attribute corresponds to a specific display method: default Beacon, inline popover, sidebar, or modal. Replace 'ARTICLE_ID' with the actual ID of the article you want to display.

```html
<!-- Open Article in Beacon -->
<a href="#" data-beacon-article="ARTICLE_ID"></a>

<!-- Open Article in a popover -->
<a href="#" data-beacon-article-inline="ARTICLE_ID"></a>

<!-- Open Article in a sidebar -->
<a href="#" data-beacon-article-sidebar="ARTICLE_ID"></a>

<!-- Open Article in a modal -->
<a href="#" data-beacon-article-modal="ARTICLE_ID"></a>
```

--------------------------------

### Add Border and Background for Categories

Source: https://docs.helpscout.com/article/835-css-styles-to-snag

Styles the categories list in Docs, adding a white background and a bottom border. Allows customization of background and border colors using hex codes.

```CSS
.category-list .category {
	background-color:#FFFFFF;
	border-bottom: 1px solid #DBDBDB;
	border-radius: 3px;
	border-left:0;
	border-right:0;
	border-top:0;
}
```