ballerinax/hubspot.marketing.emails Ballerina library

Overview

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

The ballerinax/hubspot.marketing.emails package offers APIs to connect and interact with the HubSpot Marketing Emails API endpoints, specifically based on the HubSpot REST API.

Using this API, users can develop applications easily that enables you to track marketing emails.

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 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 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 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. (Second tab next to App Info)

   

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

   • content
   • transactional-email (Optional, see note below)
   • marketing-email (Optional, see note below)

Note: To use the publish and unpublish endpoints add one of transactional-email or marketing-email scopes. However a Hubspot Enterprise Account or Trasactional Email Add-on enabled is required to use these two endpoints.

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

Note: If you are using a localhost redirect url, make sure to have a listener running at the relevant port before executing the next step.

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.

Quickstart

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

Step 1: Import the module

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

import ballerinax/hubspot.marketing.emails as hsmemails;
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 a hsmevents:ConnectionConfig 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 hsmemails:Client hsmemailClient = check new ({auth});

Step 3: Invoke the connector operation

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

Get statistics for Marketing Emails

public function main() returns error? {
    hsmemails:AggregateEmailStatistics emailStatistics = check hsmemailClient->/statistics/list({},
     {
         startTimestamp: "2024-12-12T04:27:02Z",
         endTimestamp: "2024-12-19T04:27:02Z"
     });
}

Examples

The Hubspot Marketing Emails connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering use cases:

1. Bulk Change Reply To Email - Change the Reply To and Custom Reply To email address of all draft emails

2. Marketing Email Statistics Logger - Retrieve and log the statistics of marketing emails during a specific time period.