-
Notifications
You must be signed in to change notification settings - Fork 4.2k
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.
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
Update hubspot source documentation with correct scopes #22618
Conversation
@lazebnyi this is a GA connector, so can you take a quick look and approve the PR if this seems like it make sense, please? This is a doc update cc @Amruta-Ranade |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @lucaswiley
Waiting for final approval from @lazebnyi |
docs/integrations/sources/hubspot.md
Outdated
| `products` | `e-commerce` | | ||
| `property_history` | `crm.objects.contacts.read` | | ||
| `property_history` | `crm.objects.property_history.read` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For property_history only crm.objects.contacts.read
is reqired - https://legacydocs.hubspot.com/docs/methods/contacts/get_contacts
Let's just leave crm.objects.contacts.read
scope
docs/integrations/sources/hubspot.md
Outdated
| `email_events` | `content` | | ||
| `engagements` | `crm.objects.contacts.read` | | ||
| `engagements` | `crm.objects.engagements.read` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For engagements stream crm.objects.companies.read
, crm.objects.contacts.read
, crm.objects.deals.read
, tickets
, e-commerce
scopes are reqired - https://legacydocs.hubspot.com/docs/methods/engagements/get-all-engagements
If you get 403 error on the Hubspot API I think you need check API version. |
Thanks! Addressed your review. The 403 is incorrect scopes related, I put screenshot of error in PR description. After changing scopes, 403 is gone. |
Thanks for the tag! Looks good to me :) |
@lucaswiley Yes 403 is incorect scopes, but may be you use scopes what relevant for other version of API. For some endpoint with different API version we should use different scopes. |
* Update hubspot.md * Update hubspot.md
What
Hubspot source documentation has incorrect scopes for
companies, deals, owners
and a few others, which leads to nulling out of tables in the destination because it throws a 403 on the Hubspot API. Does not throw an error within Airbyte so it's a bit mysterious.How
Update the docs to list the correct scopes.
Recommended reading order
x.java
y.python
🚨 User Impact 🚨
Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.
Pre-merge Checklist
Expand the relevant checklist and delete the others.
New Connector
Community member or Airbyter
airbyte_secret
./gradlew :airbyte-integrations:connectors:<name>:integrationTest
.README.md
bootstrap.md
. See description and examplesdocs/integrations/<source or destination>/<name>.md
including changelog. See changelog exampledocs/integrations/README.md
airbyte-integrations/builds.md
Airbyter
If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.
/test connector=connectors/<name>
command is passing/publish
command described hereUpdating a connector
Community member or Airbyter
airbyte_secret
./gradlew :airbyte-integrations:connectors:<name>:integrationTest
.README.md
bootstrap.md
. See description and examplesdocs/integrations/<source or destination>/<name>.md
including changelog. See changelog exampleAirbyter
If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.
/test connector=connectors/<name>
command is passing/publish
command described hereConnector Generator
-scaffold
in their name) have been updated with the latest scaffold by running./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates
then checking in your changes