docs(audiences): add FAQ for HubSpot deal stage filter requiring internal ID - #2298
Merged
Merged
Conversation
…rnal ID Customer could not filter Companies audience by Closed Won deal stage because the Stage filter requires HubSpot's internal stage ID value, not the human-readable display name. Adds FAQ with steps to look up the internal ID in HubSpot Settings → Objects → Deals → Pipelines. Closes DOC-2042
Contributor
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
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.
What changed
Added a new FAQ to
docs/audiences.md: "Why does my HubSpot deal Stage filter return no results in a Companies audience?" — explaining that the Stage filter requires HubSpot's internal stage ID value (not the human-readable display name), with step-by-step instructions for finding the internal ID in HubSpot.Why
A customer (Patrick Trost, Juicebox) could not filter their Companies audience by "Closed Won" HubSpot deal stage. They noticed "Closed Lost" worked when entering
closedlost, but "Closed Won" — which in their custom pipeline uses a numeric internal ID — did not respond to "closed", "won", or "closedwon". The support agent (Bo) identified the root cause: Clay stores the raw HubSpotdealstageinternal ID, not the display label. The workaround (look up the internal ID in HubSpot Settings → Objects → Deals → Pipelines) was confirmed working by the customer.The docs had no mention of this behavior. The existing
hubspot-integration-overview.mddocuments lifecycle stage internal codes in Clay tables, but nothing covers the deal Stage filter in Audiences.Source link(s)
clay-base/apps/frontend/src/components/Sources/types/action/registry/HubspotSources.ts:118—'Deal Stage': { path: ['properties.dealstage'], type: DataType.TEXT, filter: dealFilter }— the Audiences filter maps directly to HubSpot's rawdealstageproperty (the internal ID string), with no label resolution.clay-base/services/big-source-sync/src/services/domain/hubspot/hubspot-crm-export-utils.ts:189–228—buildHubspotCsvRowTransformcasts booleans and numbers but does not transformdealstage— it is stored verbatim as-is from HubSpot.clay-base/services/audiences/src/utils/field-mapping-helpers.ts:120–121— For HubSpot imports,fieldId = mapping.hubspotFieldIdreads the raw source field directly, confirming no label translation on the Audiences import path.public-actions/apps/hubspot-new-ui/actions/utils.ts:379–384— The regular Clay table enrichment path DOES adddealstageLabelby resolving the pipeline stage display name. The Audiences big-source-sync path has no equivalent — confirming the gap is real.#all-product-progress) confirmed readable labels were added to HubSpot deal enrichment action results in Clay tables (dealstageLabel) — but the verifier confirmed this does not apply to the Audiences filter path.Uncertainties
None — the Docsbot Verifier sub-agent returned PASS. The customer confirmed the workaround worked. The HubSpot Deals in Audiences feature is gated (early access), consistent with the existing note in the doc.
Related observations
hubspot-integration-overview.mdalready has a FAQ about lifecycle stage internal codes (general case for Clay tables). No change needed there — this is an Audiences-specific issue.Closes DOC-2042