Learn how to manage authentication for your apps and when developing locally.
Bearer
HTTP authorization header. For example, if you wanted to retrieve contacts for the account with an access token of 00000000-aaaa-xxx-yyyy-zzzzzzzzzzzz
, your request would resemble the following:
type
subproperty within the auth
field of your app’s app-hsmeta.json
config to oauth
. You’ll also need to set the distribution
property to marketplace
or private
based on how you plan to distribute your app:
marketplace
: used if you want the app to be eligible for listing on the HubSpot App Marketplace.private
: used if you only want to install your app in a specific set of allowlisted accounts. If you choose this option, you can install your app in a maximum of 10 accounts at a time.type
subproperty (within the auth
field) in your app’s app-hsmeta.json
config to static
, and set the distribution
field to private
.
Learn more in the app configuration guide.
hapikey
query parameter, often accompanied by the associated appId
query parameter that corresponds to the app you want to make changes for. For example, the cURL
snippet below provides an example of using the custom channel registration endpoint:
app-hsmeta.json
authentication config. For example, if your app required access to create contacts, you’d need to include the crm.contacts.write
.
Learn more about scopes.
hs account auth
command. If you’re configuring local authentication for the first time, you can also use the hs init
command.
Learn more about [installing the HubSpot CLI]. A full list of CLI commands is provided here