Skip to content
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

Merged
merged 4 commits into from
Feb 9, 2023

Conversation

lucaswiley
Copy link
Contributor

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.

Screenshot 2023-02-08 at 2 53 10 PM

Screenshot 2023-02-08 at 2 54 31 PM

Screenshot 2023-02-08 at 2 54 33 PM

Screenshot 2023-02-08 at 2 54 36 PM

How

Update the docs to list the correct scopes.

Recommended reading order

  1. x.java
  2. 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

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here
Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.
  • /test connector=connectors/<name> command is passing
  • New Connector version released on Dockerhub and connector version bumped by running the /publish command described here
Connector Generator
  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -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
  • Documentation which references the generator is updated as needed

@octavia-squidington-iii octavia-squidington-iii added area/documentation Improvements or additions to documentation community labels Feb 8, 2023
@YowanR
Copy link
Contributor

YowanR commented Feb 9, 2023

@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

Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @lucaswiley

@marcosmarxm marcosmarxm requested a review from lazebnyi February 9, 2023 12:13
@marcosmarxm
Copy link
Member

Waiting for final approval from @lazebnyi

| `products` | `e-commerce` |
| `property_history` | `crm.objects.contacts.read` |
| `property_history` | `crm.objects.property_history.read` |
Copy link
Collaborator

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

| `email_events` | `content` |
| `engagements` | `crm.objects.contacts.read` |
| `engagements` | `crm.objects.engagements.read` |
Copy link
Collaborator

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

@lazebnyi
Copy link
Collaborator

lazebnyi commented Feb 9, 2023

If you get 403 error on the Hubspot API I think you need check API version.

@lucaswiley
Copy link
Contributor Author

lucaswiley commented Feb 9, 2023

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.

@Amruta-Ranade
Copy link
Contributor

@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

Thanks for the tag! Looks good to me :)

@lazebnyi
Copy link
Collaborator

lazebnyi commented Feb 9, 2023

@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.

@lazebnyi lazebnyi self-requested a review February 9, 2023 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation community
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants