helpscout.com
Help Scout exposes HTTP APIs for Docs, Inbox, Chat, and Apps/Beacon integrations plus Beacon mobile SDKs; recorded auth is Docs API key over Basic auth, OAuth Bearer token for Chat, app secret for signed app callbacks, and a Beacon secure-mode secret, while Inbox and some Beacon surfaces remain auth-undetermined.
- Help Scout Docs APIdiscovered
- Help Scout Inbox APIdiscovered
- Help Scout Chat APIdiscovered
- Help Scout Apps callback surfacediscovered
- Help Scout Beacon JavaScript APIdiscovered
In your Help Scout account, click the profile/person icon, open Your Profile, then go to Authentication → API Keys to generate, view, or regenerate your Docs API key. If you do not see an API key, an account owner or administrator must grant the Docs: Create new, edit settings & Collections permission first. See Docs API Overview.
Log in to Help Scout as an administrator or account owner, go to Manage > Apps, click Create, then Create App, and complete the form for your app. Use the app's credentials to obtain OAuth access tokens for Help Scout APIs. Help Scout's app setup flow is described in Apps Getting Started, and API requests shown in the Chat API docs use Authorization: Bearer oauth_token in Chat API endpoint docs.
Create a Help Scout App in Manage > Apps → Create → Create App, then set the Secret Key field in the app form. Help Scout includes an X-HelpScout-Signature query parameter on requests to your app callback URLs, and you use this shared secret to verify the signature as described in Signature Validation.
conventions · 0/7 published
- integrations.json——
- llms.txt✗
/llms.txt - API catalog✗
/.well-known/api-catalog - OpenAPI document✗
/api/schema/, /openapi.json, /swagger.json, /api/openapi.json, or /v1/openapi.json - MCP server card✗
/.well-known/mcp/server-card.json - OAuth protected resource✗
/.well-known/oauth-protected-resource - Agent card✗
/.well-known/agent-card.json - Agent skills✗
/.well-known/agent-skills/index.json
Publish these signals → /publishing