Ballerina HubSpot CRM Engagement Notes Connector

Overview

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

The ballerinax/module-ballerinax-hubspot.crm.engagement.notes connector offers APIs to connect and interact with the Hubspot Engagement Notes API endpoints, specifically based on the HubSpot REST API.

Setup guide

Step 1: Create/Login to a HubSpot Developer Account

If you already have a HubSpot Developer Account, go to the HubSpot developer portal.

If you don't have an 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 only for development and testing purposes. In production you should not use Developer Test Accounts.

1. Go to Test accounts section from the left sidebar.

   

2. Click on the Create developer test account button on the top right corner.

   

3. In the pop-up window, provide a name for the test account and click on the Create button.

   

4. You will see the newly created test account in the list of test accounts.

   

Step 3: Create a HubSpot App

1. Now navigate to the Apps section from the left sidebar and click on the Create app button on the top right corner.

   

2. Provide a public app name and description for your app.

   

Step 4: Setup authentication

1. Move to the Auth tab.

   

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

   

3. In the Redirect URL section, add the redirect URL for your app. This is the URL where the user will be redirected after the authentication process. You can use localhost for testing purposes. Then hit the Create App button.

   

Step 5: Get the Client ID and Client Secret

Navigate to the Auth tab and you will see the Client ID and Client Secret for your app. Make sure to save these values.

Step 6: Setup Authentication Flow

Before proceeding with the Quickstart, ensure 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_SCOPES> with your specific value.

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

   

3. A code will be displayed 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 above step 3 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 will return the access token necessary for API calls.

   {
     "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 Engagement Notes connector in your Ballerina application, update the .bal file as shown below:

Step 1: Import the module

Import the hubspot.crm.engagement.notes module and oauth2 module.

import ballerina/oauth2;
import ballerinax/hubspot.crm.engagement.notes as hsengnotes;

Step 2: Instantiate a new connector

1. Instantiate hsengnotes:OAuth2RefreshTokenGrantConfig with the obtained credentials and initialize the connector with it.

   configurable string clientId = ?;
   configurable string clientSecret = ?;
   configurable string refreshToken = ?;
   
   hsengnotes:OAuth2RefreshTokenGrantConfig auth = {
      clientId,
      clientSecret,
      refreshToken,
      credentialBearer: oauth2:POST_BODY_BEARER
   };
   
   final hsengnotes:Client hubSpotNotes = check new ({auth});

2. 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>"

Step 3: Invoke the connector operation

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

Get the note with a given ID

public function main() returns error? {
   string noteId = ""; // ID of the note that needs to be read
   hsengnotes:SimplePublicObjectWithAssociations readResponse = check hubSpotNotes->/[noteId]();
}

Step 4: Run the Ballerina application

bal run

Examples

The Ballerina HubSpot CRM Engagement Notes Connector connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

1. Managing a single note - Operations on a single note such as creating, updating and deleting, as well as getting a list of available notes and searching for a note by its content.

2. Working with a batch of notes - Operations on a batch of notes such as creating, updating and deleting, as well as getting notes by their ID.

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.crm.engagement.notes 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.