https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.forms
This Ballerina connector provides capabilities to integrate with HubSpot Marketing Forms API.
https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.forms
ballerina connectors hubspot integration library marketing
Last synced: 3 months ago
JSON representation
This Ballerina connector provides capabilities to integrate with HubSpot Marketing Forms API.
- Host: GitHub
- URL: https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.forms
- Owner: ballerina-platform
- License: apache-2.0
- Created: 2024-12-16T04:44:40.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-05-19T05:31:33.000Z (5 months ago)
- Last Synced: 2025-05-19T06:30:34.815Z (5 months ago)
- Topics: ballerina, connectors, hubspot, integration, library, marketing
- Language: Ballerina
- Size: 3.03 MB
- Stars: 0
- Watchers: 46
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Ballerina HubSpot Marketing Forms connector
[](https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.forms/actions/workflows/ci.yml)
[](https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.forms/commits/master)
[](https://github.com/ballerina-platform/ballerina-library/labels/module%hubspot.marketing.forms)
## Overview
[HubSpot ](https://www.hubspot.com/) is an AI-powered customer relationship management (CRM) platform.
The `hubspot.marketing.forms` offers APIs to connect and interact with the [Marketing Forms](https://developers.hubspot.com/docs/reference/api/marketing/forms) endpoints, specifically based on the [HubSpot REST API](https://developers.hubspot.com/docs/reference/api/overview).
> **Note:** This package may be changed in the future based on the HubSpot API changes, since it is currently under development and is subject to change based on testing and feedback. By using this package, you are agreeing to accept any future changes that might occur and understand the risk associated with testing an unstable API.
> Refer to the [HubSpot Developer Terms](https://legal.hubspot.com/developer-terms) & [Developer Beta Terms](https://legal.hubspot.com/developerbetaterms) for more information.
## Setup guide
To use the HubSpot Marketing Forms 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](https://app.hubspot.com/)
If you don't have a HubSpot Developer Account you can sign up to a free account [here](https://developers.hubspot.com/get-started)
### Step 2 (Optional): Create a Developer Test Account
Within app developer accounts, you can create [developer test account](https://developers.hubspot.com/beta-docs/getting-started/account-types#developer-test-accounts) 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 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.
### 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: 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 scopes" button.
- `forms`
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 also use `localhost` addresses for local development 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 using the following steps:
1. Create an authorization URL using the following format:
```
https://app.hubspot.com/oauth/authorize?client_id=&scope=&redirect_uri=
```
Replace the ``, `` and `` 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 intall the app when prompted.
3. A code will be displayed in the browser. Copy the code.
4. Run the following curl command. Replace the ``, ` and `` with your specific value. Use the code you received in the above step 3 as the ``.
- Linux/macOS
```bash
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=&redirect_uri=&client_id=&client_secret='
```
- Windows
```bash
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=&redirect_uri=&client_id=&client_secret='
```
This command will return the access token necessary for API calls.
```json
{
"token_type": "bearer",
"refresh_token": "",
"access_token": "",
"expires_in": 1800
}
```
5. Store the access token securely for use in your application.
## Quickstart
To use the "HubSpot Marketing Forms" connector in your Ballerina application, update the `.bal` file as follows:
### Step 1: Import the module
Import the `hubspot.marketing.forms` module and `oauth2` module.
```ballerina
import ballerinax/hubspot.marketing.forms as hsmforms;
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:
```toml
clientId =
clientSecret =
refreshToken =
```
2. Instantiate a `hsmforms:ConnectionConfig` with the obtained credentials and initialize the connector with it.
```ballerina
configurable string clientId = ?;
configurable string clientSecret = ?;
configurable string refreshToken = ?;
final hsmforms:ConnectionConfig hsmformsConfig = {
auth : {
clientId,
clientSecret,
refreshToken,
credentialBearer: oauth2:POST_BODY_BEARER
}
};
final hsmforms:Client hsmformsClient = check new (hsmformsConfig);
```
### Step 3: Invoke the connector operation
Now, utilize the available connector operations. A sample usecase is shown below.
#### Create a Marketing Form
```ballerina
public function main() returns error? {
hsforms:FormDefinitionCreateRequestBase inputFormDefinition = {
formType: "hubspot",
name: "for",
createdAt: "2024-12-23T07:13:28.102Z",
updatedAt: "2024-12-23T07:13:28.102Z",
archived: false,
fieldGroups: [
{
groupType: "default_group",
richTextType: "text",
fields: [
{
objectTypeId: "0-1",
name: "email",
label: "Email",
required: true,
hidden: false,
fieldType: "email",
validation: {
blockedEmailDomains: [],
useDefaultBlockList: false
}
}
]
},
{
groupType: "default_group",
richTextType: "text",
fields: [
{
objectTypeId: "0-1",
name: "firstname",
label: "First name",
required: true,
hidden: false,
fieldType: "single_line_text"
},
{
objectTypeId: "0-1",
name: "lastname",
label: "Last name",
required: true,
hidden: false,
fieldType: "single_line_text"
}
]
},
{
groupType: "default_group",
richTextType: "text",
fields: [
{
objectTypeId: "0-1",
name: "message",
label: "Message",
required: true,
hidden: false,
fieldType: "multi_line_text"
}
]
}
],
configuration: {
language: "en",
createNewContactForNewEmail: true,
editable: true,
allowLinkToResetKnownValues: true,
lifecycleStages: [],
postSubmitAction: {
'type: "thank_you",
value: "Thank you for subscribing!"
},
prePopulateKnownValues: true,
cloneable: true,
notifyContactOwner: true,
recaptchaEnabled: false,
archivable: true,
notifyRecipients: ["example@example.com"]
},
displayOptions: {
renderRawHtml: false,
cssClass: "hs-form stacked",
theme: "default_style",
submitButtonText: "Submit",
style: {
labelTextSize: "13px",
legalConsentTextColor: "#33475b",
fontFamily: "arial, helvetica, sans-serif",
legalConsentTextSize: "14px",
backgroundWidth: "100%",
helpTextSize: "11px",
submitFontColor: "#ffffff",
labelTextColor: "#33475b",
submitAlignment: "left",
submitSize: "12px",
helpTextColor: "#7C98B6",
submitColor: "#ff7a59"
}
},
legalConsentOptions: {
'type: "none"
}
};
hsforms:FormDefinitionBase response = check baseClient->/.post(
inputFormDefinition
);
}
```
## Examples
The "HubSpot Marketing Forms" connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.forms/tree/main/examples), covering the following use cases:
1. [Contact Us Form Integration](https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.forms/tree/main/examples/contact-us-form) - Build dynamic 'Contact Us' forms to handle customer inquiries efficiently, enabling seamless communication and accurate data collection.
2. [Sign Up Form Integration](https://github.com/ballerina-platform/module-ballerinax-hubspot.marketing.forms/tree/main/examples/sign-up-form) - Create, update, and manage user registration forms with customizable fields such as name, email, and consent checkboxes to streamline user onboarding.
## Build from the source
### Setting up the prerequisites
1. Download and install Java SE Development Kit (JDK) version 21. You can download it from either of the following sources:
* [Oracle JDK](https://www.oracle.com/java/technologies/downloads/)
* [OpenJDK](https://adoptium.net/)
> **Note:** After installation, remember to set the `JAVA_HOME` environment variable to the directory where JDK was installed.
2. Download and install [Ballerina Swan Lake](https://ballerina.io/).
3. Download and install [Docker](https://www.docker.com/get-started).
> **Note**: Ensure that the Docker daemon is running before executing any tests.
4. Export Github Personal access token with read package permissions as follows,
```bash
export packageUser=
export packagePAT=
```
### Build options
Execute the commands below to build from the source.
1. To build the package:
```bash
./gradlew clean build
```
2. To run the tests:
```bash
./gradlew clean test
```
3. To build the without the tests:
```bash
./gradlew clean build -x test
```
4. To run tests against different environments:
```bash
./gradlew clean test -Pgroups=
```
5. To debug the package with a remote debugger:
```bash
./gradlew clean build -Pdebug=
```
6. To debug with the Ballerina language:
```bash
./gradlew clean build -PbalJavaDebug=
```
7. Publish the generated artifacts to the local Ballerina Central repository:
```bash
./gradlew clean build -PpublishToLocalCentral=true
```
8. Publish the generated artifacts to the Ballerina Central repository:
```bash
./gradlew clean build -PpublishToCentral=true
```
## Contribute to Ballerina
As an open-source project, Ballerina welcomes contributions from the community.
For more information, go to the [contribution guidelines](https://github.com/ballerina-platform/ballerina-lang/blob/master/CONTRIBUTING.md).
## Code of conduct
All the contributors are encouraged to read the [Ballerina Code of Conduct](https://ballerina.io/code-of-conduct).
## Useful links
* For more information go to the [`hubspot.marketing.forms` package](https://central.ballerina.io/ballerinax/hubspot.marketing.forms/latest).
* For example demonstrations of the usage, go to [Ballerina By Examples](https://ballerina.io/learn/by-example/).
* Chat live with us via our [Discord server](https://discord.gg/ballerinalang).
* Post all technical questions on Stack Overflow with the [#ballerina](https://stackoverflow.com/questions/tagged/ballerina) tag.