ballerinax/hubspot.marketing.events Ballerina library

Overview

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

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

Setup guide

To use the HubSpot Marketing Events 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 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. Developer Test Accounts must not be used in production environments.

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

   

2. Click Create developer test account.

   

3. In the dialog 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.objects.marketing_events.read
   • crm.objects.marketing_events.write

   

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.

   

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.

Step 7 (Optional): Generate a Developer API Key to retrieve and change Application Settings

Note: This step is optional and only required if you want to retrieve and change application settings via the client.

1. Go to the Developer API Key section in the HubSpot Developer Portal.

   

2. Click on "Create Key".

   

3. Copy the API Key.

   

4. Store the API Key securely for use in your application.

Quickstart

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

Step 1: Import the module

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

import ballerina/oauth2;
import ballerinax/hubspot.marketing.events as hsmevents;

Step 2: Instantiate a new connector

1. Create a Config.toml file in the root directory of the Ballerina project and configure the obtained credentials in the above steps as follows:

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

   Note (Optional): If you want to use Set and Get Application Settings operations, you need to provide the Developer API Key in the Config.toml file as well.

   clientId = "<Client Id>"
   clientSecret = "<Client Secret>"
   refreshToken = "<Refresh Token>"
   apiKey = "<API Key>"

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

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

   Note (Optional): To use the Set and Get Application Settings operations, you need to instantiate a separate client object with the API Key as the auth token. This client can be used only for these operations.

   configurable string clientId = ?;
   configurable string clientSecret = ?;
   configurable string refreshToken = ?;
   configurable string apiKey = ?;
   
   final hsmevents:ConnectionConfig config = {
      auth : {
         clientId,
         clientSecret,
         refreshToken,
         credentialBearer: oauth2:POST_BODY_BEARER
      },
   };
   
   final hsmevents:Client hsmevents = check new (config);
   
   // Create a separate client object for Set and Get Application Settings operations
   
   final hsmevents:ConnectionConfig configWithApiKey = {
      auth : {
            hapikey: apiKey,
            private\-app\-legacy: ""
      }
   };
   
   final hsmevents:Client hsmevents2 = check new (configWithApiKey);

Step 3: Invoke the connector operation

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

Create a Marketing Event

MarketingEventCreateRequestParams payload = {
   externalAccountId: 11111,
   externalEventId: 10000,
   eventName: "Winter webinar",
   eventOrganizer: "Snowman Fellowship",
   eventCancelled: false,
   eventUrl: "https://example.com/holiday-jam",
   eventDescription: "Let's plan for the holidays",
   eventCompleted: false,
   startDateTime: "2024-08-07T12:36:59.286Z",
   endDateTime: "2024-08-07T12:36:59.286Z",
   customProperties: []
};

public function main() returns error? {
    hsmevents:MarketingEventDefaultResponse createEvent = check hsmevents->postEvents_create(payload);
}

(Optional) Get Application Settings

int:Signed32 appId = 12345; // Your App ID
EventDetailSettings response = check hsmevents2->getAppidSettings_getall(appId); // Need to use the Client with API Key Authentication

Examples

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

1. Event Participation Management - Use Marketing Event API to Manage and Update Participants seamlessly.
2. Marketing Event Management - Create, update and manage multiple Marketing Events and automate event management.