Skip to content

Update service URL and improve documentation for HubSpot CRM Tasks Connector #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThisaruGuruge merged 2 commits into from
Feb 28, 2025
Merged

Update service URL and improve documentation for HubSpot CRM Tasks Connector #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4a808a
Refactor README.md and update notes and examples for HubSpot CRM Task…
ChathuraIshara Feb 28, 2025
23695ff
Update service URL in test.bal to use a constant value
ChathuraIshara Feb 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ If you don't have a HubSpot Developer Account you can sign up to a free account

Within app developer accounts, you can create [developer test accounts](https://developers.hubspot.com/beta-docs/getting-started/account-types#developer-test-accounts) 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.**
>**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.
![Hubspot developer portal](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.engagements.tasks/refs/heads/main/docs/resources/test_acc_1.png)
Expand All @@ -49,7 +49,9 @@ Within app developer accounts, you can create [developer test accounts](https://
1. Move to the Auth Tab.
![Hubspot app creation 2](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.engagements.tasks/refs/heads/main/docs/resources/create_app_2.png)

2. In the Scopes section, add necessary scopes for your app using the "Add new scope" button.
2. In the Scopes section, add the necessary scopes for your app using the "Add new scope" button:
- `crm.objects.contacts.read`
- `crm.objects.contacts.write`
![Hubspot set scope](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.engagements.tasks/refs/heads/main/docs/resources/set_scope.png)

3. Add your Redirect URI in the relevant section. You can also use localhost addresses for local development purposes. Click Create App.
Expand Down Expand Up @@ -117,8 +119,8 @@ To use the `HubSpot Engagements Tasks connector` in your Ballerina application,
Import the `hubspot.crm.engagements.tasks` module and `oauth2` module.

```ballerina
import ballerinax/hubspot.crm.engagements.tasks as hstasks;
import ballerina/oauth2;
import ballerinax/hubspot.crm.engagements.tasks as hstasks;
```

### Step 2: Instantiate a new connector
Expand All @@ -139,7 +141,7 @@ import ballerina/oauth2;
}
};

final hstasks:Client hsTasksClient = check new (config);
final hstasks:Client hsTasks = check new (config);
```

2. Create a `Config.toml` file and, configure the obtained credentials in the above steps as follows:
Expand Down Expand Up @@ -177,7 +179,7 @@ public function main() returns error? {
"hs_task_subject": "A sample task for example"
}
};
hstasks:SimplePublicObject response = check hsTasksClient->/.post(payload = taskCreateInput);
hstasks:SimplePublicObject response = check hsTasks->/.post(payload = taskCreateInput);
}
```

Expand All @@ -191,6 +193,10 @@ bal run

The `HubSpot CRM Tasks` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.engagements.tasks/tree/main/examples), covering the following use cases:

1. [Task management in HubSpot CRM](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.engagements.tasks/tree/main/examples/assign-or-extend-a-task) - This example searches for a task in HubSpot CRM by its subject, creating a new one if none exists or updating details like the due date and priority if found.

2. [Task completion and status change in HubSpot CRM](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.engagements.tasks/tree/main/examples/mark-a-task-as-completed) - This example checks a task's status in HubSpot CRM and updates it to "Completed" if necessary, ensuring efficient task management.

[//]: # (TODO: Add examples)

## Build from the source
Expand Down
15 changes: 10 additions & 5 deletions ballerina/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you don't have a HubSpot Developer Account you can sign up to a free account

Within app developer accounts, you can create [developer test accounts](https://developers.hubspot.com/beta-docs/getting-started/account-types#developer-test-accounts) 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.**
>**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.
![Hubspot developer portal](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.engagements.tasks/refs/heads/main/docs/resources/test_acc_1.png)
Expand All @@ -41,7 +41,9 @@ Within app developer accounts, you can create [developer test accounts](https://
1. Move to the Auth Tab.
![Hubspot app creation 2](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.engagements.tasks/refs/heads/main/docs/resources/create_app_2.png)

2. In the Scopes section, add necessary scopes for your app using the "Add new scope" button.
2. In the Scopes section, add the necessary scopes for your app using the "Add new scope" button:
- `crm.objects.contacts.read`
- `crm.objects.contacts.write`
![Hubspot set scope](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-hubspot.crm.engagements.tasks/refs/heads/main/docs/resources/set_scope.png)

3. Add your Redirect URI in the relevant section. You can also use localhost addresses for local development purposes. Click Create App.
Expand Down Expand Up @@ -108,8 +110,8 @@ To use the `HubSpot Engagements Tasks connector` in your Ballerina application,
Import the `hubspot.crm.engagements.tasks` module and `oauth2` module.

```ballerina
import ballerinax/hubspot.crm.engagements.tasks as hstasks;
import ballerina/oauth2;
import ballerinax/hubspot.crm.engagements.tasks as hstasks;
```

### Step 2: Instantiate a new connector
Expand All @@ -130,7 +132,7 @@ import ballerina/oauth2;
}
};

final hstasks:Client hsTasksClient = check new (config);
final hstasks:Client hsTasks = check new (config);
```

2. Create a `Config.toml` file and, configure the obtained credentials in the above steps as follows:
Expand Down Expand Up @@ -168,7 +170,7 @@ public function main() returns error? {
"hs_task_subject": "A sample task for example"
}
};
hstasks:SimplePublicObject response = check hsTasksClient->/.post(payload = taskCreateInput);
hstasks:SimplePublicObject response = check hsTasks->/.post(payload = taskCreateInput);
}
```

Expand All @@ -182,3 +184,6 @@ bal run

The `HubSpot CRM Tasks` connector provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.engagements.tasks/tree/main/examples), covering the following use cases:

1. [Task management in HubSpot CRM](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.engagements.tasks/tree/main/examples/assign-or-extend-a-task) - This example searches for a task in HubSpot CRM by its subject, creating a new one if none exists or updating details like the due date and priority if found.

2. [Task completion and status change in HubSpot CRM](https://github.com/ballerina-platform/module-ballerinax-hubspot.crm.engagements.tasks/tree/main/examples/mark-a-task-as-completed) - This example checks a task's status in HubSpot CRM and updates it to "Completed" if necessary, ensuring efficient task management.
5 changes: 2 additions & 3 deletions ballerina/tests/test.bal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ import ballerina/oauth2;
import ballerina/test;

configurable boolean isLiveServer = false;
final string serviceUrl = isLiveServer ? "https://api.hubapi.com/crm/v3/objects/tasks" : "http://localhost:9090";
configurable string clientId="client_id";
configurable string clientSecret = "client_secret";
configurable string refreshToken = "refresh_token";
Expand All @@ -32,13 +31,13 @@ isolated function initClient() returns Client|error {
refreshToken: refreshToken,
credentialBearer: oauth2:POST_BODY_BEARER
};
return check new ({auth}, serviceUrl);
return check new ({auth}, "https://api.hubapi.com/crm/v3/objects/tasks");
}
return check new ({
auth: {
token: "test-token"
}
}, serviceUrl);
}, "http://localhost:9090");
}

final Client taskClient = check initClient();
Expand Down
Loading