Skip to content

Commit

Permalink
Add helpscout-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nalanj committed Jan 30, 2025
1 parent 28787d9 commit 39c5cb4
Show file tree
Hide file tree
Showing 3 changed files with 97 additions and 0 deletions.
52 changes: 52 additions & 0 deletions docs-v2/integrations/all/helpscout-docs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: Help Scout Docs
sidebarTitle: Help Scout Docs
provider: helpscout-docs
---

import Overview from "/snippets/overview.mdx";
import PreBuiltTooling from "/snippets/generated/helpscout-docs/PreBuiltTooling.mdx"
import PreBuiltUseCases from "/snippets/generated/helpscout-docs/PreBuiltUseCases.mdx"

<Overview />
<PreBuiltTooling />
<PreBuiltUseCases />

## Access requirements
| Pre-Requisites | Status | Comment|
| - | - | - |
| Paid dev account || |
| Paid test account || |
| Partnership || |
| App review || |
| Security audit || |

## Setup guide

_No setup guide yet._

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

<Note>Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/helpscout-docs.mdx)</Note>


## Useful links
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/)

<Note>Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/helpscout-docs.mdx)</Note>

## 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.
- Both `helpscout-docs` and `helpscout-mailbox` enforce different rate limits based on your current plan. For more details, please check the rate limiting guidelines for [HelpScout Docs](https://developer.helpscout.com/docs-api/#rate-limiting) and [HelpScout Mailbox](https://developer.helpscout.com/mailbox-api/overview/rate-limiting/).

<Note>Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs-v2/integrations/all/helpscout-docs.mdx)</Note>

<Card title="Connect to Help Scout" icon="link" href="/integrations/all/helpscout-docs/connect" horizontal>
Guide to connect to Help Scout using Nango Connect.
</Card>
40 changes: 40 additions & 0 deletions docs-v2/snippets/generated/helpscout-docs/PreBuiltTooling.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## Pre-built tooling
<AccordionGroup>
<Accordion title="✅ Authorization">
| Tools | Status |
| - | - |
| Pre-built authorization (Basic) ||
| Pre-built authorization UI ||
| Custom authorization UI ||
| End-user authorization guide ||
| Expired credentials detection ||
</Accordion>
<Accordion title="✅ Read & write data">
| Tools | Status |
| - | - |
| Pre-built integrations | 🚫 (time to contribute: &lt;48h) |
| API unification ||
| 2-way sync ||
| Webhooks from Nango on data modifications ||
| Real-time webhooks from 3rd-party API | 🚫 (time to contribute: &lt;48h) |
| Proxy requests ||
</Accordion>
<Accordion title="✅ Observability & data quality">
| Tools | Status |
| - | - |
| HTTP request logging ||
| End-to-type type safety ||
| Data runtime validation ||
| OpenTelemetry export ||
| Slack alerts on errors ||
| Integration status API ||
</Accordion>
<Accordion title="✅ Customization">
| Tools | Status |
| - | - |
| Create or customize use-cases ||
| Pre-configured pagination | 🚫 (time to contribute: &lt;48h) |
| Pre-configured rate-limit handling | 🚫 (time to contribute: &lt;48h) |
| Per-customer configurations ||
</Accordion>
</AccordionGroup>
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## Pre-built integrations

_No pre-built integration yet (time to contribute: &lt;48h)_

<Tip>Not seeing the integration you need? [Build your own](https://docs.nango.dev/guides/custom-integrations/overview) independently.</Tip>

0 comments on commit 39c5cb4

Please sign in to comment.