diff --git a/integrations/integration-guides/hubspot.mdx b/integrations/integration-guides/hubspot.mdx index 061f6ae2..97c4b826 100644 --- a/integrations/integration-guides/hubspot.mdx +++ b/integrations/integration-guides/hubspot.mdx @@ -42,78 +42,86 @@ The official HubSpot integration allows your bot to interact with your HubSpot a - A [published bot](/get-started/quick-start) - A [HubSpot account](https://hubspot.com) - - - - - - 1. In Botpress Studio, select **Explore Hub** in the upper-right corner. - 2. Search for the **HubSpot** integration, then select **Install Integration**. - 3. In the **Configuration** menu, select the drop-down menu, then select **Configure the integration using a HubSpot integration token**. - 4. Copy the webhook URL—you'll need it when configuring your HubSpot app. - 5. Leave the configuration fields empty for now—you'll come back to them after you've setup your HubSpot app. - - - - - - Next, you'll need to create a HubSpot app for your bot: - - 1. Open a new tab and [log into your HubSpot account](https://app.hubspot.com/login). - 2. In the upper-right corner, select your organization name, then select **Profile & Preferences**. - 3. Under **Account Management**, select **Integrations**, then **Legacy Apps**. - 4. Select **Create** in the upper-right corner. Then, select **Private**. - - - - - Now, add the required scopes for the HubSpot app to work: - - 1. In the **Scopes** section, select **+ Add new scope**. - 2. Add the following scopes: - - `oauth` - - `tickets` - - `crm.objects.contacts.read` - - `crm.objects.contacts.write` - - `crm.objects.owners.read` - - `crm.objects.companies.read` - - `crm.objects.companies.write` - - `crm.objects.leads.read` - - `crm.objects.leads.write` - - `crm.objects.deals.read` - - `crm.objects.deals.write` - 3. When you're done, select **Update**. - - - - Optionally, you can subscribe to Webhook events—these are necessary if you want to use the integration's [Triggers](/studio/concepts/triggers): - - 1. Navigate to the **Webhooks** tab, then paste the webhook URL you copied earlier into the **Target URL** field. - 2. Set **Event throttling** to `1`, then select **Create subscription**. - 3. Enable **Use expanded object support**. - 4. From the **Which object types** drop-down, select: - - Company - - Contact - - Ticket - - Lead - 5. From the **Listen for which events** drop-down, select: - - Created - - Deleted - 6. Select **Subscribe**. - 7. Select **Create app** in the upper-right corner. Then, select **Continue creating**. - - - - - Now you can use your app's credentials to fill in the configuration fields from [Step 1](#step-1-install-the-hubspot-integration-in-botpress): - - 1. From your HubSpot app's menu, navigate to the **Auth** tab. - 2. Copy the **Access token** and **Client secret**. - 3. Paste them into the integration's **Access Token** and **Client Secret** fields. - 4. Scroll down and select **Save Configuration**. This automatically activates the integration. - - - + + + ### Step 1: Install the HubSpot integration in Botpress + + + In Botpress Studio, select **Explore Hub** in the upper-right corner. + Search for the **HubSpot** integration, then select **Install Integration**. + In the **Configuration** menu, select the drop-down menu, then select **Manual configuration, use your own HubSpot app**. + Copy the webhook URL—you'll need it when configuring your HubSpot app. + Leave the configuration fields empty for now—you'll come back to them after you've setup your HubSpot app. + + + ### Step 2: Create a HubSpot app + + Next, you'll need to create a HubSpot app for your bot: + + + Open a new tab and [log into your HubSpot account](https://app.hubspot.com/login). + In the upper-right corner, select your organization name, then select **Profile & Preferences**. + Under **Account Management**, select **Integrations**, then **Legacy Apps**. + Select **Create legacy app** in the upper-right corner. Then, select **Private**. + + + ### Step 3: Add scopes to your HubSpot app + + Now, add the required scopes for the HubSpot app to work: + + + In the **Scopes** section, select **+ Add new scope**. + + Add the following scopes: + - `oauth` + - `tickets` + - `crm.objects.contacts.read` + - `crm.objects.contacts.write` + - `crm.objects.owners.read` + - `crm.objects.companies.read` + - `crm.objects.companies.write` + - `crm.objects.leads.read` + - `crm.objects.leads.write` + - `crm.objects.deals.read` + - `crm.objects.deals.write` + + When you're done, select **Update**. + + + ### Step 4: Subscribe to Webhook events (optional) + + Optionally, you can subscribe to Webhook events—these are necessary if you want to use the integration's [Triggers](/studio/concepts/triggers): + + + Navigate to the **Webhooks** tab, then paste the webhook URL you copied earlier into the **Target URL** field. + Set **Event throttling** to `1`, then select **Create subscription**. + Enable **Use expanded object support**. + + From the **Which object types** drop-down, select: + - Company + - Contact + - Ticket + - Lead + + + From the **Listen for which events** drop-down, select: + - Created + - Deleted + + Select **Subscribe**. + Select **Create app** in the upper-right corner. Then, select **Continue creating**. + + + ### Step 5: Configure the integration in Botpress + + Now you can use your app's credentials to fill in the configuration fields from [Step 1](#install-the-hubspot-integration-in-botpress): + + + From your HubSpot app's menu, navigate to the **Auth** tab. + Copy the **Access token** and **Client secret**. + Paste them into the integration's **Access Token** and **Client Secret** fields. + Scroll down and select **Save Configuration**. This automatically activates the integration. +