Ballerina HubSpot CRM Associations connector

Overview

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

The ballerinax/hubspot.crm.associations offers APIs to connect and interact with the HubSpot Association Details API endpoints, specifically based on the HubSpot REST API.

Setup guide

To use the HubSpot Association connector, you need a HubSpot developer account and an associated app with API access. If you don’t have one, register for a HubSpot developer account first.

Step 1: Login to the HubSpot developer account

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

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

Step 2: Create a developer test account (Optional)

Within app developer accounts, you can create a developer test account under your 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 the 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. 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.

   • media_bridge.read
   • tickets
   • e-commerce
   • crm.objects.goals.read
   • crm.objects.custom.write
   • crm.objects.custom.read
   • crm.objects.listings.write
   • crm.objects.orders.read
   • crm.objects.deals.read
   • crm.objects.subscriptions.read
   • crm.objects.companies.read
   • crm.objects.companies.write
   • crm.objects.users.read
   • crm.objects.users.write
   • crm.objects.invoices.write
   • crm.objects.carts.write
   • crm.objects.appointments.write
   • crm.objects.contacts.read
   • crm.objects.services.write
   • crm.objects.orders.write
   • crm.objects.commercepayments.read
   • crm.objects.deals.write
   • crm.objects.invoices.read
   • crm.objects.appointments.read
   • crm.objects.quotes.write
   • crm.objects.leads.write
   • crm.objects.leads.read
   • crm.objects.contacts.write
   • crm.objects.partner-clients.write
   • crm.objects.line_items.read
   • crm.objects.line_items.write
   • crm.objects.courses.read
   • crm.objects.listings.read
   • crm.objects.courses.write
   • crm.objects.quotes.read
   • crm.objects.partner-clients.read
   • crm.objects.carts.read
   • crm.objects.services.read

   

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:9090 for testing purposes. Then click 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 or Refresh 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 install 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 and refresh token which are necessary for API calls.

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

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

Quickstart

To use the HubSpot CRM Associations connector in your Ballerina application, update the .bal file as follows:

Step 1: Import the module

Import the hubspot.crm.associations module and oauth2 module.

import ballerina/oauth2;
import ballerinax/hubspot.crm.associations as hsassociations;

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 hsassociations:ConnectionConfig with the obtained credentials and initialize the connector with it.

   configurable string clientId = ?;
   configurable string clientSecret = ?;
   configurable string refreshToken = ?;
   
   hsassociations:ConnectionConfig config = {
       auth: {
           clientId,
           clientSecret,
           refreshToken,
           credentialBearer: oauth2:POST_BODY_BEARER
       }
   };
   
   final hsassociations:Client hubspot = check new (config);

Step 3: Invoke the connector operation

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

Get list all associations of an object by object type and object id

public function main() returns error? {
    hsassociations:CollectionResponseMultiAssociatedObjectWithLabelForwardPaging readResponse 
    = check hubspot->/objects/["fromObjectType"]/["fromObjectId"]/associations/["toObjectType"];
}

Examples

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

1. Create and read associations – This example demonstrates how to use the HubSpot CRM Associations connector to batch-create default and custom-labeled associations between deals and companies, as well as retrieve existing associations for a given deal.
2. Create and delete associations - This example demonstrates how to use the HubSpot CRM Associations connector to create individual default associations with and without labels between deals and companies. It then shows how to delete a specific association label between them, followed by deleting all associations between the two objects.

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.associations 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.