HubSpot credentials
You can use these credentials to authenticate the following nodes:
Supported authentication methods
- App token: Use with the HubSpot node.
- Developer API key: Use with the HubSpot Trigger node.
- OAuth2: Use with the HubSpot node.
HubSpot deprecated the regular API Key authentication method. The option still appears in Otera, but you should use the authentication methods listed above instead. If you have existing integrations using this API key method, refer to HubSpot's Migrate an API key integration to a private app guide and set up an app token.
Related resources
Refer to HubSpot's API documentation for more information about the service. The HubSpot Trigger node uses the Webhooks API; refer to HubSpot's Webhooks API documentation for more information about that service.
Using App token
To configure this credential, you'll need a HubSpot account or HubSpot developer account and:
- An App Token
To generate an app token, create a private app in HubSpot:
- In your HubSpot account, select the settings icon in the main navigation bar.
- In the left sidebar menu, go to Integrations > Private Apps.
- Select Create private app.
- On the Basic Info tab, enter your app's Name.
- Hover over the placeholder logo and select the upload icon to upload a square image that will serve as the logo for your app.
- Enter a Description for your app.
- Open the Scopes tab and add the appropriate scopes. Refer to Required scopes for HubSpot node for a complete list of scopes you should add.
- Select Create app to finish the process.
- In the modal, review the info about your app's access token, then select Continue creating.
- Once your app's created, open the Access token card and select Show token to reveal the token.
- Copy this token and enter it in your Otera credential.
Refer to the HubSpot Private Apps documentation for more information.
Using Developer API key
To configure this credential, you'll need a HubSpot developer account and:
- A Client ID: Generated once you create a public app.
- A Client Secret: Generated once you create a public app.
- A Developer API Key: Generated from your Developer Apps dashboard.
- An App ID: Generated once you create a public app.
To create the public app and set up the credential:
- Log into your HubSpot app developer account.
- Select Apps from the main navigation bar.
- Select Get HubSpot API key. You may need to select the option to Show key.
- Copy the key and enter it in Otera as the Developer API Key.
- Still on the HubSpot Apps page, select Create app.
- On the App Info tab, add an App name, Description, Logo, and any support contact info you want to provide. Anyone encountering the app would see these.
- Open the Auth tab.
- Copy the App ID and enter it in Otera.
- Copy the Client ID and enter it in Otera.
- Copy the Client Secret and enter it in Otera.
- In the Scopes section, select Add new scope.
- Add all the scopes listed in Required scopes for HubSpot Trigger node to your app.
- Select Update.
- Copy the Otera OAuth Redirect URL and enter it as the Redirect URL in your HubSpot app.
- Select Create app to finish creating the HubSpot app.
Refer to the HubSpot Public Apps documentation for more detailed instructions.
Required scopes for HubSpot Trigger node
If you're creating an app for use with the HubSpot Trigger node, Otera recommends starting with these scopes:
| Element | Object | Permission | Scope name |
|---|---|---|---|
| n/a | n/a | n/a | oauth |
| CRM | Companies | Read | crm.objects.companies.read |
| CRM | Companies schemas | Read | crm.schemas.companies.read |
| CRM | Contacts | Read | crm.objects.contacts.read |
| CRM | Contacts schemas | Read | crm.schemas.contacts.read |
| CRM | Deals | Read | crm.objects.deals.read |
| CRM | Deals schemas | Read | crm.schemas.deals.read |
Some HubSpot accounts don't have access to all the scopes. HubSpot is migrating accounts gradually. If you can't find all the scopes in your current HubSpot developer account, try creating a fresh developer account.
Required scopes for HubSpot node
If you're creating an app for use with the HubSpot node, Otera recommends starting with these scopes:
| Element | Object | Permission | Scope name(s) |
|---|---|---|---|
| n/a | n/a | n/a | oauth |
| n/a | n/a | n/a | forms |
| n/a | n/a | n/a | tickets |
| CRM | Companies | Read Write | crm.objects.companies.read crm.objects.companies.write` |
| CRM | Companies schemas | Read | crm.schemas.companies.read |
| CRM | Contacts schemas | Read | crm.schemas.contacts.read |
| CRM | Contacts | Read Write | crm.objects.contacts.read crm.objects.contacts.write |
| CRM | Deals | Read Write | crm.objects.deals.read crm.objects.deals.write |
| CRM | Deals schemas | Read | crm.schemas.deals.read |
| CRM | Owners | Read | crm.objects.owners.read |
| CRM | Lists | Write | crm.lists.write |
Some HubSpot accounts don't have access to all the scopes. HubSpot is migrating accounts gradually. If you can't find all the scopes in your current HubSpot developer account, try creating a fresh developer account.