Add HubSpot Events Completions connector documentation - #618
Merged
Conversation
Adds the full four-page doc set for ballerinax/hubspot.events.completions under the CRM & Sales catalog category: overview, setup guide, action reference, and a validated example guide with six low-code UI screenshots showing the connector wired up end-to-end in WSO2 Integrator. Generated with connector-doc-generator (overview, setup guide, action reference) and the ballerina-libdev generate-connector-docs Claude Code skill (example guide, screenshots, sample project), then hand-reviewed to fix the generator's naive title-casing of "HubSpot" and remove the raw Ballerina package identifier from prose per the site's established connector-doc conventions.
daneshk
requested review from
KavinduZoysa,
NipunaRanasinghe,
anupama-pathirage and
rosensilva
as code owners
August 9, 2026 08:54
Contributor
📝 WalkthroughWalkthroughAdded complete HubSpot Events Completions connector documentation, including setup, event operations, examples, catalog metadata, and sidebar navigation. ChangesHubSpot Events Completions
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@en/docs/connectors/catalog/crm-sales/hubspot.events.completions/action-reference.md`:
- Around line 94-96: Update both fenced HTTP response examples in the document,
including the block near the `HTTP/1.1 204 No Content` example and the
additional block referenced by the review, to use the supported `bash` language
identifier. Preserve the response content unchanged.
- Around line 48-55: Add the ballerina/http import to the client initialization
sample alongside the existing ballerinax/hubspot.events.completions import, so
the http:Response references in the operation samples resolve correctly.
In `@en/docs/connectors/catalog/crm-sales/hubspot.events.completions/example.md`:
- Around line 104-106: Update the “Track customer purchase events” link in the
connector examples list to point to an existing connector repository sample or a
valid local documentation page using a lowercase, hyphenated path; do not retain
the broken crm-sales/examples relative link.
In `@en/docs/connectors/catalog/crm-sales/hubspot.events.completions/overview.md`:
- Line 10: Apply sentence case to all specified non-H1 headings: in
en/docs/connectors/catalog/crm-sales/hubspot.events.completions/overview.md:10
change “Key Features” to “Key features”; in setup-guide.md:16 and :38 change
“Create a Service Key” to “Create a service key” and “Create a Custom Event
Definition” to “Create a custom event definition”; and in action-reference.md:59
change “Event Reporting” to “Event reporting”.
In
`@en/docs/connectors/catalog/crm-sales/hubspot.events.completions/setup-guide.md`:
- Around line 40-45: Update the event setup instructions near the Custom Events
workflow to cover both Professional and Enterprise HubSpot accounts. Add the
Professional API-based event-definition creation path and explicitly require the
`behavioral_events.event_definitions.read_write` scope, while retaining the
existing Enterprise UI instructions.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 71d0d360-2ad8-4e0b-a722-a2ddfa583443
⛔ Files ignored due to path filters (9)
en/static/img/connectors/catalog/crm-sales/hubspot.events.completions/ballerinax_hubspot_events_completions_screenshot_01_palette.pngis excluded by!**/*.pngen/static/img/connectors/catalog/crm-sales/hubspot.events.completions/ballerinax_hubspot_events_completions_screenshot_02_connection_form.pngis excluded by!**/*.pngen/static/img/connectors/catalog/crm-sales/hubspot.events.completions/ballerinax_hubspot_events_completions_screenshot_03_connections_list.pngis excluded by!**/*.pngen/static/img/connectors/catalog/crm-sales/hubspot.events.completions/ballerinax_hubspot_events_completions_screenshot_04_operations_panel.pngis excluded by!**/*.pngen/static/img/connectors/catalog/crm-sales/hubspot.events.completions/ballerinax_hubspot_events_completions_screenshot_05_operation_form.pngis excluded by!**/*.pngen/static/img/connectors/catalog/crm-sales/hubspot.events.completions/ballerinax_hubspot_events_completions_screenshot_06_completed_flow.pngis excluded by!**/*.pngen/static/img/connectors/catalog/crm-sales/hubspot.events.completions/service-key-created.jpgis excluded by!**/*.jpgen/static/img/connectors/catalog/crm-sales/hubspot.events.completions/service-key-select-scope.jpgis excluded by!**/*.jpgen/static/img/connectors/catalog/crm-sales/hubspot.events.completions/service-keys-list.jpgis excluded by!**/*.jpg
📒 Files selected for processing (6)
en/docs/connectors/catalog/crm-sales/hubspot.events.completions/action-reference.mden/docs/connectors/catalog/crm-sales/hubspot.events.completions/example.mden/docs/connectors/catalog/crm-sales/hubspot.events.completions/overview.mden/docs/connectors/catalog/crm-sales/hubspot.events.completions/setup-guide.mden/docs/connectors/catalog/index.mdxen/sidebars.ts
Broken links, images & orphan pages
Links/images come from one crawl of the production build (baseUrl-aware). Orphans are docs not referenced by Summary
Broken links & imagesIntroduced by this PRNo new broken link(s)/image(s) introduced by this PR. ✅ Already on
|
The link to the track_customer_purchase_events example used a path relative to the connector's own repo (../examples/...), which 404s once embedded in docs-integrator's page structure. Point it at the file's GitHub blob URL instead. Caught by this PR's own broken-links CI check.
- action-reference.md: add the missing ballerina/http import to the client init sample (both operation samples use http:Response), add a bash language tag to both HTTP response fences, sentence-case "Event reporting". - overview.md, setup-guide.md: sentence-case "Key features", "Create a service key", "Create a custom event definition". - setup-guide.md: clarify the Professional/Enterprise split for creating a custom event definition. Verified against HubSpot's own docs before writing this — the reviewer's suggested fix had it backwards: the UI wizard already documented here works on Professional accounts, but HubSpot's event-definitions API for creating definitions programmatically is Enterprise-only (scope behavioral_events.event_definitions.read_write).
overview.md never linked to example.md — connector-doc-generator writes overview.md before the example page exists, and nothing revisited it afterward. Root-caused and fixed in connector-doc-generator itself (ballerina-platform/ballerina-library#9013); applying the same fix here.
Checked mi.docs.wso2.com across nine vendors plus docs-integrator's own Twilio/HTTP pages: WSO2's established convention is Title Case with the connector's name in every page's title, not just the overview. Our four pages were inconsistent with each other and with that convention - overview.md had a bare connector name (no "Overview"), setup-guide.md had a generic "Setup Guide" title with no connector name, and action-reference.md/ example.md had no title at all. Root-caused and fixed in connector-doc-generator and this skill (ballerina-platform/ballerina-library#9013); applying the same fix here.
overview.md had no body H1, so the frontmatter title ("HubSpot Events
Completions Overview") was rendering as the on-page heading via Docusaurus's
fallback — same text as the browser tab. Added an explicit H1 with just the
connector name; the frontmatter title still carries the fuller form for the
browser tab. Root-caused in connector-doc-generator
(ballerina-platform/ballerina-library#9013).
2 tasks
wso2/integration-samples#155 renamed the sample to drop the "ballerinax_" prefix, matching every other connector sample in that repo (hubspot.crm.pipelines_connector_sample, not ballerinax_hubspot_crm_pipelines_connector_sample). Updated both the Devant deploy link and the GitHub source link here to match.
gayaldassanayake
approved these changes
Aug 10, 2026
daneshk
added a commit
to wso2/integration-samples
that referenced
this pull request
Aug 11, 2026
Sample integration built in WSO2 Integrator demonstrating the ballerinax/hubspot.events.completions connector's Send Event operation: an Automation entry point that sends a single custom behavioral event occurrence to HubSpot and logs the resulting HTTP status. Referenced from the connector's example documentation on docs-integrator (wso2/docs-integrator#618) via the deterministic "Try it yourself" link, which currently 404s without this PR.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ballerinax/hubspot.events.completionsunder the CRM & Sales catalog category:overview.md,setup-guide.md,action-reference.md, and a validatedexample.mdguide with six low-code UI screenshots showing the connector wired up end-to-end in WSO2 Integrator.connector-doc-generator(overview, setup guide, action reference) and theballerina-libdevgenerate-connector-docsClaude Code skill (example guide, screenshots, sample project — see ballerina-platform/ballerina-library#9013 for the tooling changes made alongside this), then hand-reviewed to fix the generator's naive title-casing of "HubSpot" and remove the raw Ballerina package identifier from prose per the site's established connector-doc conventions.en/sidebars.tsanden/docs/connectors/catalog/index.mdx.Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit