Ballerina HubSpot Marketing Subscriptions Connector

Overview

HubSpot is an AI-powered customer relationship management (CRM) platform.

The ballerinax/hubspot.marketing.subscriptions offers APIs to connect and interact with the HubSpot API for Marketing Subscriptions endpoints, specifically based on the HubSpot Marketing Events REST API.

Use the subscriptions API to programmatically subscribe or unsubscribe contacts from your email subscription types, or unsubscribe a contact from all email communication. These APIs also provide support for business units.

Setup guide

To use the HubSpot Marketing Subscriptions Connector, you must have access to the HubSpot API via a HubSpot Developer Account and a HubSpot App associated with it. If you don't already have one, you need to register for a developer account at HubSpot.

Step 1: Create/Login to a HubSpot Developer Account

If you already have an account, go to the HubSpot developer portal.

If you don't have a HubSpot Developer Account, you can sign up to a free account here.

Step 2 (Optional): Create a Developer Test Account under your account

Within app developer accounts, you can create a Developer Test Account to test apps and integrations without affecting any real HubSpot data.

Note: These accounts are intended solely for development and testing purposes and should not be used in production environments.

1. Navigate to "Test Account" section from the left sidebar.

   

2. Click "Create developer test account".

   

3. In the dialog box, provide a name to your test account and click "Create".

   

Step 3: Create a HubSpot App under your account.

1. In your developer account, navigate to the "Apps" section. Click "Create App".

   

2. Provide the necessary details, including the app name and description.

Step 4: Configure the Authentication Flow.

1. Move to the "Auth" Tab.

   

2. In the Scopes section, add the following scopes for your app by using the "Add new scope" button.

   • communication_preferences.read_write
   • communication_preferences.statuses.batch.read
   • communication_preferences.statuses.batch.write

   

3. Add your Redirect URI in the appropriate section. You can also use localhost addresses for local development purposes. Click "Create App".

   

Step 5: Get your Client ID and Client Secret

• Navigate to the "Auth" section of your app. Make sure to save the provided Client ID and Client Secret.

  

Step 6: Setup Authentication Flow

Before proceeding with the Quickstart, make sure you have obtained the Access Token using the following steps:

1. Create an authorization URL using the following format:

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

   Replace the <YOUR_CLIENT_ID>, <YOUR_REDIRECT_URI> and <YOUR_CLIENT_SECRET> with your specific value.

   Note: If you are using a localhost redirect url, make sure to have a listener running at the relevant port before executing the next step.

2. Paste it in the browser and select your developer test account to authorize the app when prompted.

   

3. An authorization code appears in the browser. Copy the code.

4. Run the following curl command. Replace the <YOUR_CLIENT_ID>, <YOUR_REDIRECT_URI> and <YOUR_CLIENT_SECRET> with your specific value. Use the code you received in the step 3 above as the <CODE>.

   • Linux/macOS

     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>'

   • Windows

     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>'

   This command returns a JSON response containing access_token and refresh_token.

   {
     "token_type": "bearer",
     "refresh_token": "<Refresh Token>",
     "access_token": "<Access Token>",
     "expires_in": 1800
   }

5. Store the access token securely for use in your application.

Quickstart

To use the HubSpot Marketing Subscriptions connector in your Ballerina application, update the .bal file as shown below:

Step 1: Import the module

Import the hubspot.marketing.subscriptions module and oauth2 module.

import ballerina/oauth2;
import ballerinax/hubspot.marketing.subscriptions as hsmsubscriptions;

Step 2: Instantiate a new connector

1. Create a Config.toml file and, configure the obtained credentials in the above steps as follows:

    clientId = <Client Id>
    clientSecret = <Client Secret>
    refreshToken = <Refresh Token>

2. Instantiate a hsmsubscriptions:ConnectionConfig with the obtained credentials and initialize the connector with it.

   configurable string clientId = ?;
   configurable string clientSecret = ?;
   configurable string refreshToken = ?;
   
   final hsmsubscriptions:ConnectionConfig hsmSubscriptionsConfig = {
       auth : {
           clientId,
           clientSecret,
           refreshToken,
           credentialBearer: oauth2:POST_BODY_BEARER
       }
   };
   
   final hsmsubscriptions:Client hsmSubscriptions = check new (hsmSubscriptionsConfig);

Step 3: Invoke the connector operation

Now, utilize the available connector operations. A sample use case is shown below.

Get subscription preferences for a specific contact

public function main() returns error? {
    hsmsubscriptions: ActionResponseWithResultsPublicWideStatus response = check hsmSubscriptions->getCommunicationPreferencesV4StatusesSubscriberidstring
    (subscriberUserId,channel = "EMAIL");
}

Step 4: Run the Ballerina application

bal run

Examples

The HubSpot Marketing Subscriptions connector provides practical examples that illustrate its usage in various scenarios. Explore these examples, which cover the following use cases:

1. Event-Based Email Preference Update - Check and update email preferences for event attendees, ensuring that those who unsubscribed post-event are bulk resubscribed for future engagement.

2. Bulk Opt-Out of All Email Communication - Process a batch of opt-out requests to efficiently unsubscribe multiple customers from all email communications in bulk.

Build from the source

Setting up the prerequisites

1. Download and install Java SE Development Kit (JDK) version 21. You can download it from either of the following sources:

   • Oracle JDK
   • OpenJDK

   Note: After installation, remember to set the JAVA_HOME environment variable to the directory where JDK was installed.

2. Download and install Ballerina Swan Lake.

3. Download and install Docker.

   Note: Ensure that the Docker daemon is running before executing any tests.

4. Export Github Personal access token with read package permissions as follows,

   export packageUser=<Username>
   export packagePAT=<Personal access token>

Build options

Execute the commands below to build from the source.

1. To build the package:

   ./gradlew clean build

2. To run the tests:

   ./gradlew clean test

3. To build the without the tests:

   ./gradlew clean build -x test

4. To run tests against different environments:

   ./gradlew clean test -Pgroups=<Comma separated groups/test cases>

5. To debug the package with a remote debugger:

   ./gradlew clean build -Pdebug=<port>

6. To debug with the Ballerina language:

   ./gradlew clean build -PbalJavaDebug=<port>

7. Publish the generated artifacts to the local Ballerina Central repository:

   ./gradlew clean build -PpublishToLocalCentral=true

8. Publish the generated artifacts to the Ballerina Central repository:

   ./gradlew clean build -PpublishToCentral=true

Contribute to Ballerina

As an open-source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of conduct

All the contributors are encouraged to read the Ballerina Code of Conduct.

Useful links

• For more information go to the hubspot.marketing.subscriptions package.
• For example demonstrations of the usage, go to Ballerina By Examples.
• Chat live with us via our Discord server.
• Post all technical questions on Stack Overflow with the #ballerina tag.