HubSpot Query authentication guide

This is a step-by-step guide to acquiring HubSpot credentials and authorizing the HubSpot Query component.

The HubSpot Query component can use OAuth or Private App Token for third-party authentication. This guide will only explain the Private App Token method. Read OAuth for details of the OAuth method.

Authorizing the HubSpot Query component requires four steps:

1. Obtain a Private App Token from the HubSpot portal.
2. Create a Secret in AWS Secrets Manager.
3. Add a secret definition to the Your projects menu.
4. Use the Private App Token property drop-down in the HubSpot Query component to select the secret holding the token you have created.

---

Obtain a Private App Token

1. Open HubSpot Accounts in a browser and enter valid login credentials to continue.

2. On the HubSpot Accounts dashboard, click the name of the account you will use to obtain the token.

   Note

   • This must be an app developer account.
   • You may be asked to provide additional login credentials to open the account.

3. On the HubSpot Developer Home page, click Manage apps.

4. On the Apps page, click Get HubSpot API key in the top-right of the page.
5. In the Developer App key dialog, click Show key.
6. Copy the contents of the revealed API key field, as this will be required in creating the secret.
7. Close the dialog and exit the portal.

Scopes

Your app must have certain scopes to collect data from HubSpot. Check that your app has the following scopes. If not, click the Auth tab for your app and then, in the Scopes section, click Add new scope to add each scope. For more information, read HubSpot's Scopes documentation.

• crm.lists.read
• crm.lists.write
• crm.objects.companies.read
• crm.objects.companies.write
• crm.objects.contacts.read
• crm.objects.contacts.write
• crm.objects.deals.read
• crm.objects.deals.write
• crm.objects.owners.read
• crm.schemas.deals.read
• crm.schemas.deals.write
• crm.schemas.companies.read
• crm.schemas.companies.write
• crm.schemas.contacts.read
• crm.schemas.contacts.write

---

Create an AWS Secret

Create a secret in AWS Secrets Manager. This must be in the same AWS Region as the agent selected when the project was created.

1. Log on to the AWS console, and in the search bar search for Secrets Manager to access the Secrets page.
2. Click Store a new secret.
3. Select Other type of secret and enter a Key/value pair, in which:
   • Key is a Label you will use to identify the token.
   • Value is the code you copied from the Developer App key dialog.
4. Click Next and on the next page enter a Secret name. This is the name that will appear in the Secret definitions list in your Your projects.
5. The remainder of the details aren't needed, so click Next and Next again, then Store to complete the creation of the secret.

---

Add a secret definition

Follow the steps in Secrets and secret definitions.

---

Return to Designer

1. Return to the HubSpot Query component in Designer.
2. Click into the Private App Token property.
3. Select your new secret definition representing your HubSpot Private App Token.
4. Click Save.

Got feedback or spotted something we can improve?

We'd love to hear from you. Join the conversation in the Documentation forum!