Skip to main content

Setup Guide

This guide walks you through creating a HubSpot developer app and obtaining the OAuth 2.0 credentials required to use the HubSpot Marketing Events connector.

Prerequisites​

Step 1: Log in to the HubSpot developer portal​

Log in to your HubSpot developer account.

Step 2: Create a developer test account (optional)​

Developer test accounts let you test apps and integrations without affecting real HubSpot data.

  1. Select Test accounts in the left sidebar.

    Developer portal

  2. Select Create developer test account.

    Create test account

  3. Provide a name and select Create.

    Name the test account

note

Developer test accounts are for development and testing only. Do not use them in production.

Step 3: Create a HubSpot app​

  1. Navigate to Apps and select Create App.

    Create app

  2. Provide the app name and description.

Step 4: Configure authentication​

  1. Go to the Auth tab.

    Auth tab

  2. Under Scopes, select Add new scope and add:

    • crm.objects.marketing_events.read
    • crm.objects.marketing_events.write

    Set scope

  3. Add your redirect URI and select Create App.

    Create app with redirect

Step 5: Get the client ID and client secret​

In the Auth section, copy the Client ID and Client Secret.

Get credentials

Step 6: Get the refresh token​

  1. Construct the authorization URL:

    https://app.hubspot.com/oauth/authorize?client_id=<YOUR_CLIENT_ID>&scope=<YOUR_SCOPES>&redirect_uri=<YOUR_REDIRECT_URI>

  2. Open the URL in a browser and select your developer test account.

    Select account to install app

  3. Copy the authorization code from the redirect URL.

  4. Exchange the code for tokens:

    curl --request POST \
      --url https://api.hubapi.com/oauth/v1/token \
      --header 'content-type: application/x-www-form-urlencoded' \
      --data 'grant_type=authorization_code&code=<CODE>&redirect_uri=<YOUR_REDIRECT_URI>&client_id=<YOUR_CLIENT_ID>&client_secret=<YOUR_CLIENT_SECRET>'

  5. Copy the refresh_token from the response.

tip

Store the client ID, client secret, and refresh token securely. Use Ballerina's configurable feature and a Config.toml file to supply them at runtime.

Step 7: Get a developer API key (optional)​

Some Marketing Events API calls for managing app settings require a developer API key in addition to OAuth.

  1. In your HubSpot developer account, navigate to Apps.

    Apps section

  2. Select HubSpot API key in the left sidebar.

    API key section

  3. Select Generate API key (or copy your existing key).

    Generate API key

What's next​