Help Scout OAuth2 API credentials

Fields

Field	Type	Required	Notes
Client ID clientId	string	Yes	The OAuth2 client ID
Client Secret clientSecret	password	Yes	The OAuth2 client secret
Authorization URL authUrl	string	No	Help Scout OAuth2 authorization URL
Access Token URL accessTokenUrl	string	No	Help Scout OAuth2 access token URL
Auth Query Parameters authQueryParameters	string	No	Additional query parameters
Scope scope	string	No	OAuth2 scope
Access Token accessToken	password	No	OAuth2 access token. Required for API calls.
Refresh Token refreshToken	password	No	OAuth2 refresh token. Required for automatic token renewal. Leave blank only if the token never expires.
Token Expiry (Unix timestamp) expiresAt	string	No	Unix timestamp (seconds) when the access token expires. Managed automatically after refresh.

Getting your credentials

1. Sign in to Help Scout as an administrator.
2. Open the developer area — My Apps — and create a new OAuth2 application.
3. Register BusyBot’s redirect URL against the app.
4. Copy the App ID into Client ID and the App Secret into Client Secret.
5. Complete the authorisation flow so an access token and refresh token are stored.

The auth URL, token URL and scope fields have sensible defaults; only change them if Help Scout’s documentation tells you to.

Permissions and scopes

The app acts with the permissions of the account that authorised it. For shared automation, authorise from an account whose visibility matches what the workflow should see.

Troubleshooting

• Token expired and not renewing — no refresh token is stored. Re-run the authorisation.
• Redirect mismatch during authorisation — the redirect URL registered on the Help Scout app does not match the one used.
• 403 on a mailbox — the authorising account does not have access to it in Help Scout.