Help Scout

API configuration: helpscout-docs, helpscout-mailbox

Features

Features	Status
Auth (OAuth + API Key)	✅
Sync data	✅
Perform workflows	✅
Proxy requests	✅
Receive webhooks	🚫 (time to contribute: <48h)

Missing functionalities can be implemented within 48 hours; contact the community.

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

• Help Scout Mailbox create an OAuth2 application

• Help Scout Mailbox OAuth-related docs

Need assistance getting started? Visit the community.

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 expire every 172800 seconds (2 days). Use terapi.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, check the rate limiting guidelines for HelpScout Docs and HelpScout Mailbox.

Add Getting Started links and Gotchas by editing this page