How to Embed Your Help Center 2.0 Web Support Portal
This guide walks you through embedding your Helpshift Help Center 2.0 web support portal into an HTML<iframe>
on any web page you administer.
Prerequisites
- Administrator access to your Helpshift instance
- Administrative access to the web page where you want to embed the portal
Step-by-Step Instructions
1. Access Web Support Portal Settings
- Log in to your Helpshift instance as its administrator
- On the Helpshift toolbar, click Settings
- In the navigation pane, scroll to the SUPPORT SETTINGS area
- Click Web Support Portal
The Web Support Portal page will open.
2. Generate Embed Code
- Near the top of the Web Support Portal page, click GENERATE LINK & EMBED CODE
The Generate Link & Embed Code dialog box will open.
3. Configure Portal Settings
Select App
Choose one of the following options based on your web support portal strategy:
- Single app portal: Choose the specific app name to create a standalone portal that surfaces the Help Center from one app only
- Centralized portal: Choose All to create a consolidated portal that includes Help Centers from all of your apps
Select Platform
Choose one of the following options based on your strategy:
- Platform-specific: Choose the platform name to limit the scope to documented settings and behaviors for one operating system
- Web-based: Choose Web for broader compatibility
Select Language
Choose your brand's supported language that should serve as the primary language for your embedded web support portal.
4. Optional Configuration Settings
Contact Us Page Configuration
- Purpose: Configure whether the Contact Us page that loads is app-specific
- Action: Check or clear the Directly open Contact Us page checkbox as needed
Note: This checkbox is hidden when the Select Platform list is set to All.
Header and Footer Settings
- Purpose: Accommodate embedding into web pages that already have their own header and footer
- Action: Check or clear the Hide header and footer checkbox as appropriate
5. Copy and Implement Embed Code
- Next to the HTML
<iframe>
Embed Code label, click Copy
You have now copied the HTML embed code for your web support portal.
- Open the target web page for editing
- Paste the HTML embed code snippet into the desired location
- Save your changes
6. Testing and Validation
Test that the embedded web support portal:
- Displays correctly on your web page
- Functions as expected
- Matches your planned configuration and appearance
Summary
Following these steps will successfully embed your Helpshift Help Center 2.0 web support portal into your website, providing seamless support access for your users directly within your existing web infrastructure.