APIs & Integrations
Help Scout Docs
Overview
Pre-built tooling
✅ Authorization
✅ Authorization
✅ Read & write data
✅ Read & write data
| Tools | Status |
|---|---|
| Pre-built integrations | 🚫 (time to contribute: <48h) |
| API unification | ✅ |
| 2-way sync | ✅ |
| Webhooks from Nango on data modifications | ✅ |
| Real-time webhooks from 3rd-party API | 🚫 (time to contribute: <48h) |
| Proxy requests | ✅ |
✅ Observability & data quality
✅ 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 | ✅ |
✅ Customization
✅ Customization
| Tools | Status |
|---|---|
| Create or customize use-cases | ✅ |
| Pre-configured pagination | 🚫 (time to contribute: <48h) |
| Pre-configured rate-limit handling | 🚫 (time to contribute: <48h) |
| Per-customer configurations | ✅ |
Pre-built integrations
No pre-built integration yet (time to contribute: <48h)
Not seeing the integration you need? Build your own independently.
Access requirements
| Pre-Requisites | Status | Comment |
|---|---|---|
| Paid dev account | ❓ | |
| Paid test account | ❓ | |
| Partnership | ❓ | |
| App review | ❓ | |
| Security audit | ❓ |
Setup guide
No setup guide yet.
Need help getting started? Get help in the community.
Contribute improvements to the setup guide by editing this page
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
- Help Scout Mailbox create an OAuth2 application
- Help Scout Mailbox OAuth-related docs
Contribute useful links by editing this page
API gotchas
- For Help Scout Docs Basic Auth, you will need to pass your
API keyas the username and a dummy password likeXas 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-docsandhelpscout-mailboxenforce different rate limits based on your current plan. For more details, please check the rate limiting guidelines for HelpScout Docs and HelpScout Mailbox.
Contribute API gotchas by editing this page
Connect to Help Scout
Guide to connect to Help Scout using Nango Connect.