HubSpot

The official HubSpot integration allows your bot to interact with your HubSpot account.

Setup

Automatic configuration
Manual configuration

You will need:

A published bot
A HubSpot account

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 Authorize HubSpot.
Follow the instructions to connect Botpress to your HubSpot account.

For advanced use cases, you can use your own HubSpot app with our integration.

You will need:

A published bot
A HubSpot account

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 Configure the integration using a HubSpot integration token.
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.

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.
In the upper-right corner, select your organization name, then select Profile & Preferences.
Under Account Management, select Integrations, then Legacy Apps.
Select Create in the upper-right corner. Then, select Private.

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.

Subscribe to Webhook events (optional)

Optionally, you can subscribe to Webhook events—these are necessary if you want to use the integration’s 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.

Configure the integration in Botpress

Now you can use your app’s credentials to fill in the configuration fields from Step 1:

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.

Your HubSpot integration is ready—you can use the integration’s Cards and Triggers to interact with your HubSpot account.

Cards

Here’s a reference for all Cards available with the integration:

Create Contact

Create Deal

Create Lead

Create Ticket

Delete Contact

object

This Card has no output.

Delete Deal

object

This Card has no output.

Delete Lead

object

This Card has no output.

Get Contact

Get Deal

Get Lead

List Contacts

Search Company

Search Contact

Search Deal

Search Lead

Update Contact

Update Deal

Update Lead

Triggers

Here’s a reference for all Triggers available with the integration:

You can access data returned from any of these Triggers by reading event.payload after the Trigger fires.

Get started

ADK

Studio

Integrations

Webchat

Desk

Setup

Install the HubSpot integration in Botpress

Create a HubSpot app

Add scopes to your HubSpot app

Subscribe to Webhook events (optional)

Configure the integration in Botpress

Cards

Create Contact

Create Deal

Create Lead

Create Ticket

Delete Contact

Delete Deal

Delete Lead

Get Contact

Get Deal

Get Lead

List Contacts

Search Company

Search Contact

Search Deal

Search Lead

Update Contact

Update Deal

Update Lead

Triggers

Company Created

Company Deleted

Contact Created

Contact Deleted

Ticket Created

Ticket Deleted

​Setup

Install the HubSpot integration in Botpress

Create a HubSpot app

Add scopes to your HubSpot app

Subscribe to Webhook events (optional)

Configure the integration in Botpress

​Cards

​Create Contact

​Create Deal

​Create Lead

​Create Ticket

​Delete Contact

​Delete Deal

​Delete Lead

​Get Contact

​Get Deal

​Get Lead

​List Contacts

​Search Company

​Search Contact

​Search Deal

​Search Lead

​Update Contact

​Update Deal

​Update Lead

​Triggers

​Company Created

​Company Deleted

​Contact Created

​Contact Deleted

​Ticket Created

​Ticket Deleted

Setup

Cards

Create Contact

Create Deal

Create Lead

Create Ticket

Delete Contact

Delete Deal

Delete Lead

Get Contact

Get Deal

Get Lead

List Contacts

Search Company

Search Contact

Search Deal

Search Lead

Update Contact

Update Deal

Update Lead

Triggers

Company Created

Company Deleted

Contact Created

Contact Deleted

Ticket Created

Ticket Deleted