Package: meltano-tap-hubspot
tap-hubspottap-hubspot is a Singer tap for Hubspot.Built with theMeltano Singer SDK.Capabilitiescatalogstatediscoveraboutstream-mapsschema-flatteningbatchSettingsSettingRequiredDefaultDescriptionaccess_tokenFalseNoneToken to authenticate against the API serviceclient_idFalseNoneThe OAuth app client ID.client_secretFalseNoneThe OAuth app client secret.refresh_tokenFalseNoneThe OAuth app refresh token.start_dateFalseNoneEarliest record date to syncend_dateFalseNoneLatest record date to syncstream_mapsFalseNoneConfig object for stream maps capability. For more information check outStream Maps.stream_map_configFalseNoneUser-defined config values to be used within map expressions.flattening_enabledFalseNone'True' to enable schema flattening and automatically expand nested properties.flattening_max_depthFalseNoneThe max depth to flatten schemas.batch_configFalseNoneA full list of supported settings and capabilities is available by running:tap-hubspot --aboutElastic License 2.0The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software.Installationpipxinstallgit+https://github.com/ryan-miranda-partners/tap-hubspot.gitConfigure using environment variablesThis Singer tap will automatically import any environment variables within the working directory's.envif the--config=ENVis provided, such that config values will be considered if a matching
environment variable is set either in the terminal context or in the.envfile.Source Authentication and AuthorizationA Hubspot access token is required to make API requests. (SeeHubspot APIdocs for more info)PermissionsThe following scopes need to be added to your access token to access the following endpoints:Contacts:crm.schemas.contacts.readorcrm.objects.contacts.readUsers:settings.users.readTicket Pipeline:media_bridge.readorcrm.schemas.custom.readortimelineorticketsore-commerceorcrm.objects.goals.readDeal Pipeline:media_bridge.readorcrm.schemas.custom.readortimelineorticketsore-commerceorcrm.objects.goals.readProperties: All ofTickets,crm.objects.deals.read,sales-email-read,crm.objects.contacts.read,crm.objects.companies.read,e-commerce,crm.objects.quotes.readOwners:crm.objects.owners.readCompanies:crm.objects.companies.readDeals:crm.objects.deals.readFeedback Submissions:crm.objects.contacts.readLine Items:e-commerceProducts:e-commerceTickets:ticketsQuotes:crm.objects.quotes.readorcrm.schemas.quotes.readGoals:crm.objects.goals.readEmails:sales-email-readFor more info on the streams and permissions, check theHubspot API Documentation.UsageYou can easily runtap-hubspotby itself or in a pipeline usingMeltano.Streams Using v1 EndpointsThe following Streams use the v1 (legacy) endpoint in the Hubspot API:TicketPipeline & DealPipeline: The v3 endpoint requires a pipeline ID parameter to make calls to the API. Because of this,
you are limited to only pulling data for a single pipeline ID from v3, whereas the v1 API allows you to pull from all pipelines.EmailSubscriptions: The v3 endpoint requires you to set a single email address to pull subscription data, whereas
the v1 endpoint allows you to pull data from all emails.Stream InheritanceThis project uses parent-child streams. Learn more about themhere.Executing the Tap Directlytap-hubspot--version
tap-hubspot--help
tap-hubspot--configCONFIG--discover>./catalog.jsonDeveloper ResourcesFollow these instructions to contribute to this project.Initialize your Development Environmentpipxinstallpoetry
poetryinstallCreate and Run TestsCreate tests within thetestssubfolder and
then run:poetryrunpytestYou can also test thetap-hubspotCLI interface directly usingpoetry run:poetryruntap-hubspot--helpTesting withMeltanoNote:This tap will work in any Singer environment and does not require Meltano.
Examples here are for convenience and to streamline end-to-end orchestration scenarios.Your project comes with a custommeltano.ymlproject file already created. Open themeltano.ymland follow any "TODO" items listed in
the file.Next, install Meltano (if you haven't already) and any needed plugins:# Install meltanopipxinstallmeltano# Initialize meltano within this directorycdtap-hubspot
meltanoinstallNow you can test and orchestrate using Meltano:# Test invocation:meltanoinvoketap-hubspot--version# OR run a test `elt` pipeline:meltanoelttap-hubspottarget-jsonlSDK Dev GuideSee thedev guidefor more instructions on how to use the SDK to
develop your own taps and targets.