ballerinax/hubspot.crm.lists Ballerina library

Overview

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

The HubSpot connector offers APIs to connect and interact with the HubSpot CRM Lists API endpoints, specifically based on the HubSpot REST API

Key Features

• Create, read, update, and delete CRM contact lists
• Manage list membership and filtering criteria
• Search and query lists with filtering support
• Support for static and dynamic list types

Setup guide

To use the HubSpot CRM Lists connector, you must have access to the HubSpot API through a HubSpot developer account and a HubSpot App under it. Therefore you need to register for a developer account at HubSpot if you don't have one already.

Step 1: Create/Login to a HubSpot Developer Account

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

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

Step 2 (Optional): Create a Developer Test Account

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 Account section from the left sidebar.

   

2. Click Create developer test account.

   

3. In the dialogue box, give 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 on "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 using the "Add new scope" button.

   • crm.lists.read
   • crm.lists.write
   • cms.membership.access_groups.write

   

   The scopes listed above are the mandatory scopes needed to use the HubSpot CRM Lists API. However, you may need to add additional scopes based on your use case. For example, if you are working with contacts, you may need to add crm.objects.contacts.read and crm.objects.contacts.write scopes as well.

3. Add your Redirect URI in the relevant 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, 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 install the app when prompted. Provide consent for all scopes needed.

   

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 CRM Lists connector in your Ballerina application, update the .bal file as follows:

Step 1: Import the module

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

import ballerinax/hubspot.crm.lists as hslists;
import ballerina/oauth2;

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 an OAuth2RefreshTokenGrantConfig with the obtained credentials and initialize the connector with it.

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

Step 3: Invoke the connector operation

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

Create a CRM List

public function main() returns error? {
    hslists:ListCreateRequest payload = {
        objectTypeId: "0-1",
        processingType: "MANUAL",
        name: "my-test-list"
    };
    hslists:ListCreateResponse response = check crmListClient->post_create(payload);
}

Examples

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

1. Customer Support Ticket Manager - Integrates with HubSpot CRM Lists to create filtered lists of customer support tickets based on the priority level of the ticket.
2. Leads Tracker - Integrates with HubSpot CRM Lists to create Manual Lists and add leads(contacts) to the lists.