Building apps overview
Apps enable you to authenticate API calls to your HubSpot account, subscribe to events with webhooks, and extend the HubSpot UI, such as with custom cards. HubSpot offers several types of apps and extensions depending on your integration's needs. Below, learn more about the types of apps and extensions you can build with HubSpot, how to get started building them, and how to manage them in HubSpot.
Depending on the type of integration you want to build, you’ll need to choose the right type of app. Below, learn more about the types of apps that you can build and the functionalities that they support.
For building extensions, view the reference table below for a quick overview of which extensions can be built with which types of apps.
Private apps can be created for a single HubSpot account, and are best suited for one-off scripts or single-purpose extensions. For example, you might build a private app for your HubSpot account to:
- Create a new custom object through the API.
- Import CRM records from a CSV file.
- Authenticate API requests in custom automation actions and chat bots.
- Create and edit webhook subscriptions (BETA).
In general, private apps are simpler to implement than public apps. Private apps authenticate with access tokens and cannot be listed on the HubSpot App Marketplace. Learn more about when to build private apps.
If this type of app fits your needs, get started creating a private app in your HubSpot account.
Private apps built with projects enable you to create UI extensions for CRM records. The difference when building a private app through this method is that projects only support creating UI extensions, which private apps outside of projects cannot create.
If this type of app fits your needs, check out the projects quickstart guide to get started creating a private app and project using the CLI.
Public apps can be installed in multiple accounts. In addition to the types of extensions you can build with a private app, public apps support advanced functionality, such as:
- Subscribing to account-wide events using the webhooks API.
- Creating custom timeline events on CRM records using the timeline events API.
- Creating custom app settings pages in HubSpot.
Public apps authenticate with OAuth and can be listed on the HubSpot App Marketplace. Learn more about when to build public apps.
If this type of app fits your needs, get started creating a public app in your app developer account.
While app developer and test accounts work together, they each serve a distinct purpose.
- App developer accounts are intended for building and listing apps on the App Marketplace.
- Test accounts intended for testing APIs and apps you’re building without impacting data in a real HubSpot account. This is separate from a sandbox account that you can create within standard HubSpot accounts.
Learn more about HubSpot's account types.
If you want to build a custom integration with a single HubSpot account, you can create a private app and use its access token to authenticate API calls, or you can use OAuth with a public app. Any app designed for installation by multiple HubSpot accounts or listing on the App Marketplace must use OAuth.
Please note: as of November 30, 2022, HubSpot API Keys are being deprecated and are no longer supported. Continued use of HubSpot API Keys is a security risk to your account and data. During this deprecation phase, HubSpot may deactivate your key at any time.
If you want to subscribe to webhooks or set up OAuth for your app, you should create a developer account. With developer accounts, you can also list your apps on the App Marketplace or create a test account.
Developer account API keys
To manage your app settings through the API, you can use a developer API key. This API key is separate from standard API keys, which have been deprecated. Developer API keys can be used for managing subscriptions for the Webhooks API and creating or updating event types for the timeline events feature. All other API calls need to be made using a private app access token or OAuth.
To access your app developer account API key:
- In your app developer account, navigate to Apps in the top navigation bar.
- In the upper right, click Get HubSpot API key.
- In the dialog box, click Show key. The key will be revealed, and you can then click Copy next tot he key.
- You can also deactivate the previous API key and generate a new one by clicking Regenerate key.
You can delete app developer accounts if they don’t contain apps with installations or active marketplace listings. If your account has apps with installations or active marketplace listings and you’d like to delete your account, please reach out to support for assistance.
Once you delete your account, you will no longer be able to access that account. If you can switch between multiple HubSpot accounts, the deleted account will no longer appear.
In your HubSpot API developer account, click your account name in the top right corner, then click on Account.
Click Delete account. If your account has any apps with installations or active marketplace listings this button will be disabled.
In the dialog box, enter your account ID then click Delete developer account