ballerinax/hubspot.crm.engagements.communications Ballerina library

Overview

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

The ballerinax/hubspot.crm.engagements.communications offers APIs to connect and interact with the HubSpot CRM Engagements Communications API endpoints, specifically based on the HubSpot REST API.

Setup guide

To use the HubSpot Engagements Communications 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: Login to the HubSpot developer account

If you don't have a HubSpot developer account yet, you can sign up for a free account here

If you have an account already, login 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.

   • crm.objects.contacts.read
   • crm.objects.contacts.write

   

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

Step 1: Import the module

Import the hubspot.crm.engagements.communications module and oauth2 module.

import ballerina/oauth2;
import ballerinax/hubspot.crm.engagements.communications as hscommunications;

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

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

Step 3: Invoke the connector operation

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

View logged communications

public function main() returns error? {
   hscommunications:CollectionResponseSimplePublicObjectWithAssociationsForwardPaging getCommunications = check hubspot->/.get();
   io:println("Logged communications: ", getCommunications);
}

Examples

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

1. Logging WhatsApp Messages - This example demonstrates the usage of the HubSpot CRM Communications connector to log WhatsApp messages as CRM communications. It includes posting a communication, associating it with a specific HubSpot record, retrieving the logged communication, searching for WhatsApp messages using filters, updating a communication, and deleting a communication.

2. Logging LinkedIn Messages - This example demonstrates the usage of the HubSpot CRM Communications connector to log LinkedIn messages as CRM communications. It includes posting a batch of communications, associating them with specific HubSpot records, updating a batch of logged communications, retrieving a batch of communications, and deleting a batch of communications.