- What is an API key?
- Why is HubSpot sunsetting API Keys?
- What Are Private Apps?
- How Can I Migrate Api Keys To Private Apps?
- What Can I Do If I Don’t Have The Resources To Execute This Migration?
- How Can I Keep Myself Update About This Update?
As you may have heard, HubSpot has announced that they will be sunsetting their API key authentication system.
In simple terms, this means that if you currently have any integrations with HubSpot using API Key authentication, they will no longer work as of the 30th of November 2022.
As a result of this change, integration is now required to work with Private Apps.You will need to migrate all your API key integrations to private apps.
What is an API key?
An application programming interface (API) key is a unique identifier used to authenticate a user, developer, or calling program to an API.
They are used to authenticate a project with the API rather than a human user.
Different platforms may implement and use API keys in different ways.
HubSpot uses API Keys for custom integrations with the HubSpot CRM.
So, if you’re a HubSpot user and have custom integrations in place, you are likely to have used API keys to set up these integrations as well.
But, this will no longer be the case as of November 2022.
Why is HubSpot sunsetting API Keys?
A large change like this can be a pain, we know.
However, moving away from API Keys is actually a great thing for your business for security reasons.
If you have an internal integration which uses a HubSpot API key, your API key provides both read and write access to all of your HubSpot CRM data, which can be a high risk of security if your API key is compromised.
By migrating to a private app, you can authorise the specific scopes that your integration needs, which creates an access token that limits the data that your integration can request or change in your account.
API keys also require token refreshing, while private app access tokens do not. So, you won’t need to include token refreshing as a part of your application.
In short, the less data transfer, the safer it is for your business.
What are Private Apps?
Private Apps offer tighter security and allow more granular control over your integrations and account data than legacy API keys.
Private apps allow you to use HubSpot's APIs to access specific data from your HubSpot account.
You can authorise what each private app can request or change in your account, which will generate an access token that's unique to your app.
How Can I Migrate Our HubSpot API Key Integration to Private Apps?
HubSpot has provided thorough documentation on how to manage this migration process here.
But to summarise, there are 3 main steps that needs to take place:
- Create a new private app
- Update the authorisation method of your integration's API request
- Verify requests and monitor logs
Click on the links above to find specific instructions on how to execute these steps.
I Don’t Have the Resources to Migrate this over the Next Few Months. What Can I Do?
Short on time or don’t have the right resources?
You can outsource this project to a reputable developer or HubSpot Partner to manage this project for you.
BBD Boom is an Elite HubSpot Partner that has lots of experience helping our clients implement custom integrations with HubSpot.
This means we are more than well-equipped to help you manage the entire migration process from start to finish.
If you’re looking for an experienced partner to help you implement this project ASAP and get it out of the way, you can book a discovery session with our growth team here.
How Do I Keep Myself Updated on This Update from HubSpot?
We’ve taken the liberty to collate some important information from HubSpot here so you don’t have to go Googling for all the various documentation.
Here are the key information you need to know, all in one place:
- Instructions on the migration process here: https://developers.hubspot.com/docs/api/migrate-an-api-key-integration-to-a-private-app
- Documentation on using Private Apps here: https://developers.hubspot.com/docs/api/private-apps
- Developer updates on the sunsetting here: https://developers.hubspot.com/changelog/upcoming-api-key-sunset
Ready to Migrate and Develop Your Private Apps?
Whether you’re a current client of BBD Boom, we’re happy to chat with you and provide some solutions for you with your Private Apps migrations.
To make sure you’re prepared for this huge development on 30th November, we recommend booking a call with us sooner than later to ensure you’re well prepared for this change.