https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.owners
HubSpot CRM Owners connector
https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.owners
ballerina connectors hubspot
Last synced: 17 days ago
JSON representation
HubSpot CRM Owners connector
- Host: GitHub
- URL: https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.owners
- Owner: ballerina-platform
- License: apache-2.0
- Created: 2025-02-13T00:34:54.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-05-19T05:27:48.000Z (6 months ago)
- Last Synced: 2025-05-19T06:29:29.460Z (6 months ago)
- Topics: ballerina, connectors, hubspot
- Language: Ballerina
- Size: 1.59 MB
- Stars: 0
- Watchers: 47
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Ballerina HubSpot CRM Owners connector
[](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.owners/actions/workflows/ci.yml)
[](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.owners/commits/master)
[](https://github.com/ballerina-platform/ballerina-library/labels/module%hubspot.crm.owners)
## Overview
[HubSpot](https://developers.hubspot.com) is an AI-powered customer relationship management (CRM) platform.
The `ballerinax/hubspot.crm.owners` offers APIs to connect and interact with the [HubSpot CRM Owners API](https://developers.hubspot.com/docs/reference/api/crm/owners) endpoints, specifically based on the [HubSpot REST API](https://developers.hubspot.com/docs/reference/api).
## Setup guide
To use the HubSpot CRM Owners 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 don't have a HubSpot Developer Account you can sign up to a free account [here](https://developers.hubspot.com/get-started)
If you have an account already, go to the [HubSpot developer portal](https://app.hubspot.com/)
### Step 2: Create a developer test account (Optional)
Within app developer accounts, you can create a [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 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.owners.read`
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=&scope=&redirect_uri=
```
Replace the ``, `` and `` with your specific value.
2. Paste it in the browser and select your developer test account to install the app when prompted.
3. Click `Connect App`.
4. A code will be displayed in the browser. Copy the code.
5. 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 and refresh token which are necessary for API calls.
```json
{
"token_type": "bearer",
"refresh_token": "",
"access_token": "",
"expires_in": 1800
}
```
6. Store the refresh token securely for use in your application.
## Quickstart
To use the `Hubspot CRM Owners` connector in your Ballerina application, update the `.bal` file as follows:
### Step 1: Import the module
Import the `hubspot.crm.owners` module and `oauth2` module.
```ballerina
import ballerina/oauth2;
import ballerinax/hubspot.crm.owners as hsowners;
```
### 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 `hsowners:ConnectionConfig` with the obtained credentials and initialize the connector with it.
```ballerina
configurable string clientId = ?;
configurable string clientSecret = ?;
configurable string refreshToken = ?;
hsowners:ConnectionConfig config = {
auth: {
clientId,
clientSecret,
refreshToken,
credentialBearer: oauth2:POST_BODY_BEARER
}
};
final hsowners:Client hubspot = check new (config);
```
### Step 3: Invoke the connector operation
Now, utilize the available connector operations. A sample usecase is shown below.
#### View owners
```ballerina
public function main() returns error? {
hsowners:CollectionResponsePublicOwnerForwardPaging getPageOfOwners = check hubspot->/('limit = 10);
io:println("Owners: ", getPageOfOwners);
}
```
## Examples
The `HubSpot CRM Owners` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.owners/tree/main/examples/), covering the following use cases:
1. [Retrieve the owner IDs for all users in the account to later assign CRM records across the team.](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.owners/tree/main/examples/retrieve-owner-ids) - This example demonstrates how to use the HubSpot CRM Owners connector to retrieve a page of owners from your HubSpot account. It shows how to fetch owner details—such as owner ID, first name, and last name—which can then be used to assign CRM records to team members.
## 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.crm.owners` package](https://central.ballerina.io/ballerinax/hubspot.crm.owners/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.