Source
Help-center publishing & integrations — found from sitemap — HelpDocs
Checked for HelpDocs on 10 Nov 2026
- Page
- https://support.helpdocs.io/article/ykv7l5jthy-lighthouse-widget-api
- Checked
- 10 Nov 2026, 23:42 UTC
- How we may use it
- Public page, crawling permitted
Technical details
- type
- page
- http status
- 200
- content hash
- sha256:69a2e225d6c43639d71c88d5fc0cd7794264b5dcb22d3765d7083910de10d4f3
- permission
- robots_ok
- screenshot
- Screenshot on file (internal exhibit, not published)
Cited by
Facts read from this source
-
Lighthouse plan availability Report an error
“Lighthouse is available on some of our plans”
-
Lighthouse config source Report an error
“When you initialize Lighthouse you'll have used a snippet of Javascript code from your HelpDocs dashboard in Settings > Lighthouse widget.”
-
Lighthouse language config Report an error
“language_code: 'fr', // Type: String. One of the language codes from your HelpDocs account.”
-
Lighthouse branding config Report an error
“brand: 'Support', // Type: String. Change the string that shows up in the top bar of Lighthouse.”
-
Lighthouse color config Report an error
“primary_color: '#ff63aa', // Type: String. Include a hex code you'd like Lighthouse to base all other colors from.”
-
Lighthouse jwt auth Report an error
“jwt: 'jwt-string-here', // Type: String. Include a JWT you've generated for the user to allow them access to permissioned articles. **DO NOT SEND YOUR JWT SECRET HERE**”
-
Lighthouse shared password Report an error
“shared_password: 'fluffyeggbaskets', // Type: String. Include your shared password so the user can open articles in a tab.”
-
Lighthouse rtl support Report an error
“text_direction: 'ltr|rtl', Type: String. Set to 'rtl' to change text direction to right to left. Default is left to right.”
-
Lighthouse i18n strings Report an error
“i18n: { // Change the value of the strings we use inside Lighthouse for internationalization”
-
Lighthouse contact form prefill Report an error
“user: { // Prefill contact form submission values”
-
Lighthouse disable contact button Report an error
“disable_contact_button: true, // Type: Bool. disable the contact button completely, regardless of live chat integrations”
-
Lighthouse live chat integrations Report an error
“disable_contact_button: true, // Type: Bool. disable the contact button completely, regardless of live chat integrations”
-
Lighthouse ignore contact widgets Report an error
“ignore_contact_widgets: true, // ADVANCED: Bool: string. Don't automatically detect contact widgets on the page and use the email form (or nothing) instead.”
-
Lighthouse launcher button size Report an error
“launcher_button_size: 80, // Type: Integer. Change the size of the Launcher button between 30 and 150. The default is 70.”
-
Lighthouse position config Report an error
“position: 'bottom right|bottom left', // Type: String. Set to 'bottom left' to move Lighthouse to the left corner. Defaults to the right.”
-
Lighthouse methods Report an error
“All methods are available on the window.Lighthouse variable. So you'd call e.g. window.Lighthouse.hideButton() to hide the button completely from the user.”
-
Lighthouse navigate targets Report an error
“Lighthouse.navigate('home'); Lighthouse.navigate('suggestions'); Lighthouse.navigate('article', 'abcde12345'); Lighthouse.navigate('category', '12345abcde'); Lighthouse.navigate('contact');”
-
Lighthouse callbacks Report an error
“onLoad: function () {}, // fires when Lighthouse has loaded all data from the server onReady: function () {}, // fires when the Lighthouse API is ready for use”
-
Lighthouse realtime search Report an error
“Note: Lighthouse uses realtime search, so this could be fired * up to once every 500ms”
-
Lighthouse reload Report an error
“Reloads are instant and maintain internal state, so it's safe to do these often. Use the reload() method to apply your new config after making the change to window.hdlh.”
-
Lighthouse frame width Report an error
“frame_width: '400px', // Type: String. How wide you'd like the main frame to appear.”
4 facts read from this page are not shown because they could not be confirmed on the page as captured.
Scores citing this record
- The Engineering Lead Permissions, SSO & administration
- The Engineering Lead Help-center publishing & integrations
- The Engineering Lead Pricing transparency
- The IT Administrator Permissions, SSO & administration
- The IT Administrator Help-center publishing & integrations
- The IT Administrator Pricing transparency
- The Operations Lead Permissions, SSO & administration
- The Operations Lead Help-center publishing & integrations
- The Operations Lead Pricing transparency
- The Quality Manager Permissions, SSO & administration
- The Quality Manager Help-center publishing & integrations
- The Quality Manager Pricing transparency
- The Skeptic Editor, structure & search
- The Skeptic Permissions, SSO & administration
- The Skeptic Help-center publishing & integrations
- The Skeptic Pricing transparency
- The Support Knowledge Manager Permissions, SSO & administration
- The Support Knowledge Manager Help-center publishing & integrations
- The Support Knowledge Manager Pricing transparency