AWS quick documentation change
Summary
Complete restructuring of HubSpot integration documentation, changing from MCP server connectivity to OAuth-based authentication with detailed setup steps and read-only actions.
Security assessment
The changes introduce OAuth authentication with client credentials, which improves security over previous methods. However, there's no evidence this addresses a specific vulnerability or incident. The documentation now explicitly covers secure credential handling.
Diff
diff --git a/quick/latest/userguide/hubspot-integration.md b/quick/latest/userguide/hubspot-integration.md index 5c4a2eb26..374edc0cf 100644 --- a//quick/latest/userguide/hubspot-integration.md +++ b//quick/latest/userguide/hubspot-integration.md @@ -7 +7 @@ -What you can doAvailable toolsSetting up HubSpot integrationCompatibility +PrerequisitesVerifying your HubSpot accountConfiguring your HubSpot accountSetting up the integration in Amazon QuickUsing available actionsTroubleshooting @@ -11 +11 @@ What you can doAvailable toolsSetting up HubSpot integrationCompatibility -With HubSpot integration in Amazon Quick, you can manage contacts, deals, marketing campaigns, and customer relationships through MCP server connectivity. This integration provides action capabilities for CRM and marketing operations. +Access your HubSpot CRM data directly from Amazon Quick using natural language. With the HubSpot action connector, you can retrieve and list contacts, companies, deals, and tickets without leaving Amazon Quick. @@ -13 +13 @@ With HubSpot integration in Amazon Quick, you can manage contacts, deals, market -## What you can do +HubSpot is available as a built-in connector in Amazon Quick. To set up this integration, complete the following two steps. First, prepare your HubSpot account with the required access. Then, create the connector in Amazon Quick and authenticate with your HubSpot credentials. @@ -15 +15 @@ With HubSpot integration in Amazon Quick, you can manage contacts, deals, market -HubSpot integration provides action connector capabilities through MCP server connectivity: +This connector supports Custom OAuth app authentication. For information about the authentication methods that Amazon Quick supports, see [Authentication methods](./quick-action-auth.html). @@ -17 +17 @@ HubSpot integration provides action connector capabilities through MCP server co - * Create and manage contacts and companies +## Prerequisites @@ -19 +19 @@ HubSpot integration provides action connector capabilities through MCP server co - * Track and update deals in the sales pipeline +Before you set up the integration, verify that you have the following resources and access. @@ -21 +21 @@ HubSpot integration provides action connector capabilities through MCP server co - * Create and manage marketing campaigns + * An active HubSpot account with an admin role. @@ -23 +23 @@ HubSpot integration provides action connector capabilities through MCP server co - * Log and track customer interactions + * Permissions to access CRM data including contacts, companies, deals, and tickets in your HubSpot account. @@ -25 +25 @@ HubSpot integration provides action connector capabilities through MCP server co - * Generate reports and analytics + * A subscription that meets the requirements described in [Set up integrations in the console](./integration-console-setup-process.html). @@ -27 +26,0 @@ HubSpot integration provides action connector capabilities through MCP server co - * Manage tickets and customer support cases @@ -30,0 +30 @@ HubSpot integration provides action connector capabilities through MCP server co +## Verifying your HubSpot account @@ -32 +32 @@ HubSpot integration provides action connector capabilities through MCP server co -## Available tools +Before you configure Amazon Quick, verify that your HubSpot account meets the following requirements. @@ -34 +34 @@ HubSpot integration provides action connector capabilities through MCP server co -The HubSpot MCP server typically provides these tools: + * Your HubSpot account is active and you can sign in to the [HubSpot sign-in page](https://app.hubspot.com/login) on the HubSpot website. @@ -36 +36 @@ The HubSpot MCP server typically provides these tools: - * `create_contact` \- Create new contacts + * The CRM data that you want to access, including contacts, companies, deals, and tickets, is accessible to your account. @@ -38 +37,0 @@ The HubSpot MCP server typically provides these tools: - * `get_contact` \- Retrieve contact information @@ -40 +38,0 @@ The HubSpot MCP server typically provides these tools: - * `update_contact` \- Update contact details @@ -42 +39,0 @@ The HubSpot MCP server typically provides these tools: - * `create_deal` \- Create new deals @@ -44 +41 @@ The HubSpot MCP server typically provides these tools: - * `update_deal` \- Update deal information +## Configuring your HubSpot account @@ -46 +43 @@ The HubSpot MCP server typically provides these tools: - * `list_deals` \- List deals in pipeline +The Custom OAuth app authentication method in Amazon Quick requires a MCP Auth app configured in your HubSpot developer settings. @@ -48 +45 @@ The HubSpot MCP server typically provides these tools: - * `create_ticket` \- Create support tickets +### To configure a MCP Auth App @@ -50 +47 @@ The HubSpot MCP server typically provides these tools: - * `search_contacts` \- Search for contacts + 1. Sign in to your HubSpot account. @@ -52 +49 @@ The HubSpot MCP server typically provides these tools: - * `create_company` \- Create company records + 2. Navigate to **Development** , and then **MCP Auth Apps**. @@ -53,0 +51 @@ The HubSpot MCP server typically provides these tools: + 3. Choose **Create MCP auth app**. @@ -54,0 +53 @@ The HubSpot MCP server typically provides these tools: + 4. On the **Create MCP Auth App** window, complete the following fields: @@ -55,0 +55 @@ The HubSpot MCP server typically provides these tools: + * **Name** – Enter a name for your app. @@ -57 +57,30 @@ The HubSpot MCP server typically provides these tools: -###### Note + * **Description** – Enter a short description. + + * **Redirect URL** – Enter `https://`region`.quicksight.aws.amazon.com/sn/oauthcallback`. Replace `region` with your AWS Region, for example, `us-east-1`. + + 5. Choose **Create**. HubSpot creates the app and generates a client ID and client secret. + +###### Important + +Record the client secret and client ID. + + + + +The client ID and client secret serve as the Client ID and Client Secret when you configure the action connector in Amazon Quick with the Custom OAuth app authentication method. + +For more information, see [HubSpot MCP server](https://developers.hubspot.com/docs/apps/developer-platform/build-apps/integrate-with-the-remote-hubspot-mcp-server) on the HubSpot website. + +## Setting up the integration in Amazon Quick + +After you verify your HubSpot account access, create the connector in Amazon Quick. + + 1. In the Amazon Quick console, choose **Connectors**. + + 2. Choose the **Create for your team** tab. + + 3. Choose **HubSpot** from the options available. + + 4. In the **HubSpot** dialog, enter the following fields: + + * **Name** – A descriptive name for your HubSpot connector. @@ -59 +88 @@ The HubSpot MCP server typically provides these tools: -The specific tools and capabilities available through this MCP server may change over time. For the most current information about supported tools, features, and implementation details, check the official HubSpot documentation and MCP server repository. + * **Description (Optional)** – Choose **\+ Add Description** to add notes about how this connector will be used. @@ -61 +90 @@ The specific tools and capabilities available through this MCP server may change -## Setting up HubSpot integration + * **Connection type** – Choose **Public network**. @@ -63 +92 @@ The specific tools and capabilities available through this MCP server may change -HubSpot integration uses MCP server connectivity to provide action capabilities. For detailed setup instructions, see [Model Context Protocol (MCP) integration](./mcp-integration.html). + 5. For the **Custom OAuth app** authentication method, enter the following fields: @@ -65 +94 @@ HubSpot integration uses MCP server connectivity to provide action capabilities. -You'll need: + * **Base URL** – This field is auto-populated as `https://mcp.hubspot.com`. @@ -67 +96 @@ You'll need: - * HubSpot account with appropriate permissions + * **Client ID** – Enter the client ID from your HubSpot MCP Auth app. @@ -69 +98 @@ You'll need: - * HubSpot API key or private app credentials + * **Client Secret** – Enter the client secret from your HubSpot MCP Auth app. @@ -70,0 +100 @@ You'll need: + * **Token URL** – This field is auto-populated as `https://api.hubapi.com/oauth/v1/token`. @@ -71,0 +102,35 @@ You'll need: + * **Authorization URL** – This field is auto-populated as `https://app.hubspot.com/oauth/authorize`. + + * **Redirect URL** – This field is auto-populated as `https://us-east-1.quicksight.aws.amazon.com/sn/oauthcallback`. + + 6. Choose **Next** , review the actions for HubSpot, and then choose **Next** again. + + 7. Specify who can access the connector: + + * To share with a team, enter a team name or group email. + + * To keep it private, leave the field blank. + + * To share with all users, toggle **Everyone in your organization**. + + 8. Choose **Publish**. + + + + +The connector appears in the **Available** panel with a status of **Connected**. + +## Using available actions + +After you set up the connector, you can use the following read-only actions to access your HubSpot CRM data. + +HubSpot available actions Action | Description +---|--- +Get CRM Objects | Fetches multiple CRM objects of the same object type in a single request. +Get properties | Fetches properties for the CRM objects. +Get user details | Fetches user details. +Search CRM Objects | Searches across CRM objects. +Search Owners | Searches across owners. +Search properties | Searches across properties. + +###### Note @@ -72,0 +138 @@ You'll need: +This connector supports read-only actions. The actions that you can use depend on the scopes configured in your HubSpot app. @@ -74 +140 @@ You'll need: -## Compatibility +## Troubleshooting @@ -76 +142 @@ You'll need: -HubSpot integration supports: +To edit, share, or delete your connector, see [Managing existing integrations](./integration-workflows.html#managing-existing-integrations). @@ -78 +144 @@ HubSpot integration supports: - * **Chat Agents:** Yes +### Resolving authentication issues @@ -80 +146 @@ HubSpot integration supports: - * **Flows:** Yes + * **Sign-in fails** – Verify that your HubSpot account is active and that you can sign in to the [HubSpot sign-in page](https://app.hubspot.com/login) on the HubSpot website. If your organization uses single sign-on (SSO), confirm that your identity provider is configured correctly. @@ -82 +148 @@ HubSpot integration supports: - * **Knowledge Base:** No + * **Access denied** – Confirm that your HubSpot user has an admin role with permissions to access CRM data. Verify that the client ID and client secret from your app are correct and that the required read scopes are configured.