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:
- Obtain a Private App Token from the HubSpot portal.
- Create a Secret in AWS Secrets Manager.
- Add a Secret definition to the Your projects menu.
- 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
- Open HubSpot Accounts in a browser and enter valid login credentials to continue.
On the HubSpot Accounts dashboard, click the name of the account you will use to obtain the token.
- This must be an app developer account.
- You may be asked to provide additional login credentials to open the account.
On the HubSpot Developer Home page, click Manage apps.
- On the Apps page, click Get HubSpot API key in the top-right of the page.
- In the Developer App key dialog, click Show key.
- Copy the contents of the revealed API key field, as this will be required in creating the secret.
- Close the dialog and exit the portal.
Create an AWS Secret
- Log on to the AWS console, and in the search bar search for Secrets Manager to access the Secrets page.
- Click Store a new secret.
- 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.
- 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.
- 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 Add new secret definition.
Return to Designer
- Return to the HubSpot Query component in Designer.
- Click into the Private App Token property.
- Select your new secret definition representing your HubSpot Private App Token.
- Click Save.