hubspot-ruby is a wrapper for the HubSpot REST API

Install the gem and add to the application's Gemfile by executing:

$ bundle add ruby_hubspot

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install ruby_hubspot

This gem uses project access token only. To find the appropriate values for either approach, please visit the HubSpot API Authentication docs: https://developers.hubspot.com/docs/api/oauth/tokens.

So, to start just add your token:

hubspot = Hubspot.new(access_token: <ACCESS_TOKEN>)

Or you can change access_token param if you need it by some reason:

hubspot.access_token = <ACCESS_TOKEN>

We recommend using <ACCESS_TOKEN> with private apps because: Hubspot API is currently transitioning its API authentication from API keys to private apps. From November 30, 2022, you will no longer be able to use HubSpot API keys as an authentication method to access HubSpot APIs. Instead, you'll need to use a private app access token or OAuth to authenticate API calls. For more information please read these: https://developers.hubspot.com/docs/api/private-apps https://developers.hubspot.com/docs/api/migrate-an-api-key-integration-to-a-private-app

There are too many versions of HubSpot endpoints. That is why we decided to make requests more flexible for now.

To get some endpoint you should know a path and a method you would like to use, please visit the HubSpot API docs: https://legacydocs.hubspot.com/docs/overview.

hubspot.request(:get, 'crm/v3/objects/contacts')

hubspot.request(:post, 'contacts/v1/contact/createOrUpdate/email/jordy@test.com', first_name: 'jordy')

Note, that if you try to call hubspot without initializing, like:

Hubspot.request

you will get NoMethodError.

There are some supported acctions for Contacts: :create_contact, :create_or_update_contact, :update_contact, :show_contact, :all_contacts, :delete_contact.

After adding access token to 'hubspot' variable you can try actions mentioned above. For changing Contacts you could use either email or id.

hubspot.all_contacts

hubspot.create_contact(email: 'test@test.co')

hubspot.create_or_update_contact(email: 'test@test.co', firstname: 'test')

hubspot.show_contact(email: 'test@test.co')

hubspot.update_contact(id: 9401, firstname: 'test')

hubspot.delete_contact(id: 9351)

There are some supported endpoints for Companies: :create_company, :update_company, :show_company, :all_companies, :delete_company.

After adding access token to 'hubspot' variable you can try actions mentioned above. Companies require :id to make some action with them except :all_companies and :create_company. The last one needs either name or domain or both.

hubspot.all_companies

hubspot.create_company(domain: 'test.test.com', name: 'test')

hubspot.update_company(id: '7107010539', name: 'test1')

hubspot.show_company(id: '7107010539')

hubspot.delete_company(id: '7107010539')

Bug reports and pull requests are welcome on GitHub at https://github.com/sofiyareverse/ruby_hubspot.