Overview

Pre-built tooling

Pre-built use-cases

No pre-built use cases yet (time to contribute: <48h)

Not seeing the use case you need? Build your own independently.

Access requirements

Pre-RequisitesStatusComment
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

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.

Contribute useful links by editing this page

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 and HelpScout Mailbox.
Contribute API gotchas by editing this page