segmentio / segment-docs

Segment Documentation. Powered by Jekyll.
https://segment.com/docs/
Creative Commons Attribution 4.0 International
48 stars 343 forks source link

[Content]: In HubSpot Source's "Collection Properties" section, make special note of "hs_lastmodifieddate" #6557

Open mccallion opened 5 months ago

mccallion commented 5 months ago

What article on segment.com/docs is affected?

https://segment.com/docs/connections/sources/catalog/cloud-apps/hubspot/#collection-properties

What part(s) of the article would you like to see updated?

The collection properties are the fields which segment tracks to detect changes to the source records. For almost every user, they would prefer Segment to detect changes to a "last updated at" timestamp. It is unclear whether or not Segment checks an "updated at" field for the objects listed in this section.

Some sections note that "hs_*" fields are included in the collection properties. This means that "hs_lastmodifieddate" is indeed included (it's actually a timestamp, not a date). For 99% of users, this is what they want to know.

This section can be improved by including a sentence at the top to call that out. Something like: "Since Segment tracks all hs_* properties for Companies and Deals, Segment will detect all changes to these records through the hs_lastmodifieddate."

(My personal headache that I'd like to help others avoid:

When I didn't see this after reading the page for the first time, I started to plan a workaround strategy. I tested a change to an unlisted field for a Deal object, and Segment registered the change. I dug deeper to discover that hs_lastmodifieddate was indeed included.)

Thank you!!!

Additional information

No response

github-actions[bot] commented 2 months ago

This issue is stale because it has been open 60 days with no activity.