HubSpot is an AI-powered customer relationship management (CRM) platform.
The ballerinax/hubspot.marketing.transactional
connector offers APIs to connect and interact with the Hubspot Marketing Transactional Emails API endpoints, specifically based on the HubSpot REST API.
To use the HubSpot Marketing Transactional Emails 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.
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
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.
-
In your developer account, navigate to the "Apps" section. Click on "Create App"
-
Provide the necessary details, including the app name and description.
-
In the Scopes section, add necessary scopes for your app using the "Add new scope" button.
-
Add your Redirect URI in the relevant section. You can also use localhost addresses for local development purposes. Click Create App.
- Navigate to the Auth section of your app. Make sure to save the provided Client ID and Client Secret.
Before proceeding with the Quickstart, ensure you have obtained the Access Token using the following steps:
-
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. -
Paste it in the browser and select your developer test account to intall the app when prompted.
-
A code will be displayed in the browser. Copy the code.
-
Run the following ballerina program or curl command.
- 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=<your_authorization_code>&redirect_uri=<your_redirect_url>&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=<your_authorization_code>&redirect_uri=<your_redirect_url>&client_id=<your_client_id>&client_secret=<your_client_secret>'
This command will return the access token and refresh token necessary for API calls.
{ "token_type": "bearer", "refresh_token": "<Refresh Token>", "access_token": "<Access Token>", "expires_in": 1800 }
-
Store the access token securely for use in your application.
To use the HubSpot Transactional Emails
connector in your Ballerina application, update the .bal
file as follows:
Import the ballerinax/hubspot.marketing.'transactional
module and ballerina/oauth2
module..
import ballerinax/hubspot.marketing.'transactional as hsmtransactional;
import ballerina/oauth2;
-
Create a
Config.toml
file and, configure the obtained credentials obtained in the above steps as follows:clientId = <Client Id> clientSecret = <Client Secret> refreshToken = <Refresh Token>
-
Instantiate a
hsmtransactional:OAuth2RefreshTokenGrantConfig
with the obtained credentials and initialize the connector with it.configurable string clientId = ?; configurable string clientSecret = ?; configurable string refreshToken = ?; hsmtransactional:OAuth2RefreshTokenGrantConfig auth = { clientId, clientSecret, refreshToken, credentialBearer: oauth2:POST_BODY_BEARER }; final hsmtransactional:Client hubSpotTransactional = check new ({ auth });
Now, utilize the available connector operations. A sample usecase is shown below.
public function main() returns error? {
hsmtransactional:SmtpApiTokenRequestEgg payload = {
createContact: true,
campaignName: "Campaign1"
};
hsmtransactional:SmtpApiTokenView response = check hubSpotTransactional->/smtp\-tokens.post(payload);
}
bal run
The Ballerina HubSpot Marketing Transactional Connector
connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- Manage Tokens - see how the HubSpot API can be used to create SMTP API token and query it and resetting the password of an existing token.
-
Download and install Java SE Development Kit (JDK) version 21. You can download it from either of the following sources:
Note: After installation, remember to set the
JAVA_HOME
environment variable to the directory where JDK was installed. -
Download and install Ballerina Swan Lake.
-
Download and install Docker.
Note: Ensure that the Docker daemon is running before executing any tests.
-
Export Github Personal access token with read package permissions as follows,
export packageUser=<Username> export packagePAT=<Personal access token>
Execute the commands below to build from the source.
-
To build the package:
./gradlew clean build
-
To run the tests:
./gradlew clean test
-
To build the without the tests:
./gradlew clean build -x test
-
To run tests against different environments:
./gradlew clean test -Pgroups=<Comma separated groups/test cases>
-
To debug the package with a remote debugger:
./gradlew clean build -Pdebug=<port>
-
To debug with the Ballerina language:
./gradlew clean build -PbalJavaDebug=<port>
-
Publish the generated artifacts to the local Ballerina Central repository:
./gradlew clean build -PpublishToLocalCentral=true
-
Publish the generated artifacts to the Ballerina Central repository:
./gradlew clean build -PpublishToCentral=true
As an open-source project, Ballerina welcomes contributions from the community.
For more information, go to the contribution guidelines.
All the contributors are encouraged to read the Ballerina Code of Conduct.
- For more information go to the
hubspot.marketing.transactional
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.