Skip to content

Commit

Permalink
Add support for Help Scout Mailbox and docs API
Browse files Browse the repository at this point in the history
  • Loading branch information
hassan254-prog committed Jan 30, 2024
1 parent 6fce964 commit f6bb92f
Show file tree
Hide file tree
Showing 7 changed files with 60 additions and 0 deletions.
34 changes: 34 additions & 0 deletions docs-v2/integrations/all/helpscout.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Help Scout
sidebarTitle: Help Scout
---

API configuration: [`helpscout-docs`](https://nango.dev/providers.yaml), [`helpscout-mailbox`](https://nango.dev/providers.yaml)

## Features

| Feature | Status |
| -------------------------------------------------------------------------------- | ------------------------------- |
| Auth ([Basic](/guides/api-key) + [OAuth](/guides/oauth))||
| [Syncs](/guides/sync) & [Actions](/guides/action) ||
| [Nango Proxy](/guides/proxy) ||
| Auto-pagination | 🚫 (time to contribute: <1h) |
| API-specific rate limits | 🚫 (time to contribute: <1h) |

<Tip>We can implement missing features in &lt;48h, just ask for it in the [community](https://nango.dev/slack).</Tip>

## Getting started
Each user has a Help Scout Docs API key, which is used to authenticate the Docs API. For the Mailbox API, OAuth2 authentication is required.

- [Help Scout Docs API](https://developer.helpscout.com/docs-api/)
- [Help Scout Mailbox create an OAuth2 application](https://developer.helpscout.com/mailbox-api/overview/authentication/#oauth2-application)
- [Help Scout Mailbox OAuth-related docs](https://developer.helpscout.com/mailbox-api/overview/authentication/)

<Tip>Need help getting started? Get help in the [community](https://nango.dev/slack).</Tip>

## API gotchas

- For Help Scout Docs Basic Auth, you will need to pass your `API key` as the username and a dummy password like `X` as the password. Each API key is associated with a Help Scout user.
- For Help Scout Mailbox, access tokens expires after every 172800 seconds which is equivalent to 2 days, you can use `nango.getConnection()` to generate a new set of tokens.

<Note>Add Getting Started links and Gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/helpscout.mdx)</Note>
1 change: 1 addition & 0 deletions docs-v2/integrations/communication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ sidebarTitle: Communication
<Card title="Facebook" href="/integrations/all/facebook" color="#68a063" />
<Card title="Front" href="/integrations/all/front" color="#68a063" />
<Card title="Gmail" href="/integrations/all/google-mail" color="#68a063" />
<Card title="Help Scout" href="/integrations/all/helpscout" color="#68a063" />
<Card title="Microsoft Teams" href="/integrations/all/microsoft-teams" color="#68a063" />
<Card title="RingCentral" href="/integrations/all/ring-central" color="#68a063" />
<Card title="Sendgrid" href="/integrations/all/sendgrid" color="#68a063" />
Expand Down
1 change: 1 addition & 0 deletions docs-v2/integrations/knowledge-base.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ Ask us on the [Slack community](https://nango.dev/slack) and we can help you qui
<Card title="Confluence" href="/integrations/all/confluence" color="#68a063" />
<Card title="Dropbox" href="/integrations/all/dropbox" color="#68a063" />
<Card title="Guru" href="/integrations/all/guru" color="#68a063" />
<Card title="Help Scout" href="/integrations/all/helpscout" color="#68a063" />
<Card title="Notion" href="/integrations/all/notion" color="#68a063" />
<Card title="One Drive" href="/integrations/all/one-drive" color="#68a063" />
<Card title="StackExchange" href="/integrations/all/stackexchange" color="#68a063" />
Expand Down
1 change: 1 addition & 0 deletions docs-v2/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,7 @@
"integrations/all/gusto",
"integrations/all/hackerrank-work",
"integrations/all/healthgorilla",
"integrations/all/helpscout",
"integrations/all/hibob",
"integrations/all/highlevel",
"integrations/all/hubspot",
Expand Down
16 changes: 16 additions & 0 deletions packages/shared/providers.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -690,6 +690,22 @@ jira:
link_path_in_response_body: _links.next
post_connection_script: jira-post-connection
webhook_routing_script: jira-webhook-routing
helpscout-docs:
auth_mode: BASIC
proxy:
base_url: https://docsapi.helpscout.net
helpscout-mailbox:
auth_mode: OAUTH2
authorization_url: https://secure.helpscout.net/authentication/authorizeClientApplication
token_url: https://api.helpscout.net/v2/oauth2/token
authorization_params:
response_type: code
token_params:
grant_type: authorization_code
refresh_params:
grant_type: refresh_token
proxy:
base_url: https://api.helpscout.net
keap:
auth_mode: OAUTH2
authorization_url: https://accounts.infusionsoft.com/app/oauth/authorize
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f6bb92f

Please sign in to comment.