forked from NangoHQ/nango
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for Help Scout Mailbox and docs API
- Loading branch information
1 parent
6fce964
commit f6bb92f
Showing
7 changed files
with
60 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 <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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletions
1
packages/webapp/public/images/template-logos/helpscout-docs.svg
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
helpscout-mailbox.svg |
6 changes: 6 additions & 0 deletions
6
packages/webapp/public/images/template-logos/helpscout-mailbox.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.