Skip to content

Commit

Permalink
Add HelpScout integration (#495)
Browse files Browse the repository at this point in the history
* Add initial helpscout integration

* Finish integration, add changeset

* Add new integration to package lock
  • Loading branch information
addisonschultz authored Jul 8, 2024
1 parent ce52dd8 commit ac68b22
Show file tree
Hide file tree
Showing 11 changed files with 4,825 additions and 2 deletions.
5 changes: 5 additions & 0 deletions .changeset/hot-ads-decide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@gitbook/integration-helpscout': major
---

This change releases the first version of the HelpScout integration for GitBook
3 changes: 3 additions & 0 deletions integrations/helpscout/.eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": ["@gitbook/eslint-config/integration"]
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added integrations/helpscout/assets/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 48 additions & 0 deletions integrations/helpscout/gitbook-manifest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: helpscout
title: HelpScout
organization: gitbook
visibility: public
description: Add the HelpScout chat widget to your published GitBook content
summary: |
# Overview
The HelpScout integration for GitBook allows you to display the HelpScout chat widget on your public documentation to connect and interact with your readers.
# How it works
Automatic chat widget on your documentation: Each of your connected GitBook spaces will fetch the HelpScout chat widget script and add it to your published content.
# Configure
You can configure the integration on single or multiple public spaces by navigating to the integrations in sub-navigation or org settings. You will then have to provide HelpScout ID to finish the configuration.
categories:
- analytics
script: src/index.tsx
icon: ./assets/icon.png
previewImages:
- assets/helpscout-preview.png
# The following scope(s) are available only to GitBook Staff
# See https://developer.gitbook.com/integrations/configurations#scopes
scopes:
- space:script:inject
- site:script:inject
secrets: {}
contentSecurityPolicy:
script-src: https://beacon-v2.helpscout.net;
configurations:
space:
properties:
helpscout_id:
type: string
title: HelpScout ID
description: Your HelpScout integration ID.
required:
- helpscout_id
site:
properties:
helpscout_id:
type: string
title: HelpScout ID
description: Your HelpScout integration ID.
required:
- helpscout_id
Loading

0 comments on commit ac68b22

Please sign in to comment.