node-hubspot

Javascript / node.js wrapper for the HubSpot API

Upgrade to 1.0

Version 1.0 was released on 2017-08-23 and included breaking changes. See the Changelog for details. If you need help upgrading, please open an issue

Installing

npm install hubspot

Instantiate client

const Hubspot = require('hubspot');
const hubspot = new Hubspot({ apiKey: 'abc' });

You can also authenticate via token:

const hubspot = new Hubspot({ accessToken: 'abc' });

To change the base url

const hubspot = new Hubspot({ accessToken: 'abc', baseUrl: 'https://some-url' });

If you're an app developer, you can also instantiate a client with your app details and a refresh_token and obtain a new accessToken:

const hubspot = new Hubspot({
  clientId: ...,
  clientSecret: ...,
  redirectUri: ...,
  refreshToken: ...
})
return hubspot.refreshAccessToken()
  .then(results => {
    console.log(results.access_token)
    console.log(hubspot.accessToken) // this assigns the new accessToken to the client, so your client is ready to use
    return hubspot.contacts.get()
  })

Usage

And then use the API method via:

hubspot.contacts.get(options)
  .then(results => {
    console.log(results)
  }).catch(err => {
    console.error(err)
  })

or if you prefer callbacks:

hubspot.contacts.get(function(err, results) {
  if (err) { console.error(err) }
  console.log(results);
});

API limits

HubSpot has relatively stringent API limits (40,000 per day by default). To prevent from consuming it all-at-once, this library checks API quotas regularly and will fail requests if the total is too close to the max. By default

Available Methods

Companies

hubspot.companies.get(opts, cb)
hubspot.companies.getById(id, cb)
hubspot.companies.getRecentlyCreated(opts, cb)
hubspot.companies.getRecentlyModified(opts, cb)
hubspot.companies.getByDomain(domain, cb)
hubspot.companies.create(data, cb)
hubspot.companies.addContactToCompany(data, cb) // data = { companyId: 123, contactVid: 123 }
hubspot.companies.getContactIds(id, options, cb)
hubspot.companies.getContacts(id, options, cb)
hubspot.companies.update(id, data, cb)
hubspot.companies.updateBatch(data, cb) // data = [{ objectId: 123, properties: [] }]
hubspot.companies.delete(id, cb)

Company properties

hubspot.companies.properties.get(query, cb) // query is optional
hubspot.companies.properties.getByName(name, cb)
hubspot.companies.properties.create(data, cb)
hubspot.companies.properties.update(name, data, cb)
hubspot.companies.properties.upsert(name, data) // not an official API, wrapper doing two API calls. Callbacks not supported at this time

Company properties groups

hubspot.companies.properties.groups.get(query, cb) // query is optional
hubspot.companies.properties.groups.create(data, cb)
hubspot.companies.properties.groups.update(name, data, cb)
hubspot.companies.properties.groups.upsert(name, data) // not an official API, wrapper doing two API calls. Callbacks not supported at this time

Contacts

hubspot.contacts.get(opts, cb)
hubspot.contacts.getByEmail(email, cb)
hubspot.contacts.getByEmailBatch(emails, cb)
hubspot.contacts.getById(id, cb)
hubspot.contacts.getByIdBatch(ids, cb)
hubspot.contacts.getByToken(utk, cb)
hubspot.contacts.update(id, data, cb)
hubspot.contacts.create(data, cb)
hubspot.contacts.createOrUpdateBatch(data, cb) // data = [{ vid/email: '', properties: [] }]
hubspot.contacts.search(query, cb)
hubspot.contacts.getRecentlyCreated(cb)
hubspot.contacts.getRecentlyModified(cb)
hubspot.contacts.createOrUpdate(email, data, cb)
hubspot.contacts.delete(id, cb)

Contact properties

hubspot.contacts.properties.get(cb)
hubspot.contacts.properties.getByName(name, cb)
hubspot.contacts.properties.create(data, cb)
hubspot.contacts.properties.update(name, data, cb)
hubspot.contacts.properties.upsert(name, data) // not an official API, wrapper doing two API calls. Callbacks not supported at this time
hubspot.contacts.properties.getGroups(cb) // => [ {name: '...', displayName: '...'}, ...]
hubspot.contacts.properties.createGroup({name, displayName}, cb)
hubspot.contacts.properties.updateGroup(name, {displayName}, cb)
hubspot.contacts.properties.deleteGroup(name, cb)
hubspot.contacts.properties.delete(name, cb)

Pages

// more opts can be found at https://developers.hubspot.com/docs/methods/pages/get_pages
hubspot.pages.get(opts, cb); // eg: opts = {is_draft: false}

Deals

hubspot.deals.get(opts, cb)
hubspot.deals.getRecentlyModified(opts, cb)
hubspot.deals.getRecentlyCreated(opts, cb)
hubspot.deals.getById(id, cb)
hubspot.deals.getAssociated(objectType, objectId, opts, cb)
hubspot.deals.deleteById(id, cb)
hubspot.deals.updateById(id, data, cb)
hubspot.deals.create(data, cb)
hubspot.deals.associate(id, objectType, associatedObjectId, cb)
hubspot.deals.removeAssociation(id, objectType, associatedObjectId, cb)

Deals properties

hubspot.deals.properties.get(query, cb) // query is optional
hubspot.deals.properties.getByName(name, cb)
hubspot.deals.properties.create(data, cb)
hubspot.deals.properties.update(name, data, cb)
hubspot.deals.properties.upsert(name, data) // not an official API, wrapper doing two API calls. Callbacks not supported at this time

Deals properties groups

hubspot.deals.properties.groups.get(query, cb) // query is optional
hubspot.deals.properties.groups.create(data, cb)
hubspot.deals.properties.groups.update(name, data, cb)
hubspot.deals.properties.groups.upsert(name, data) // not an official API, wrapper doing two API calls. Callbacks not supported at this time

Engagements

hubspot.engagements.create(data, cb)
hubspot.engagements.get(opts, cb)
hubspot.engagements.getRecentlyModified(opts, cb)
hubspot.engagements.getAssociated(objectType, objectId, opts, cb)

Owners

hubspot.owners.get(opts, cb)

Pipelines

hubspot.pipelines.get(opts, cb)

Lists

hubspot.lists.get(opts, cb)
hubspot.lists.getOne(id, cb)
hubspot.lists.getContacts(id, opts, cb)
hubspot.lists.getRecentContacts(id, opts, cb)
hubspot.lists.addContacts(id, contactBody, cb)

Files

hubspot.files.get(cb)
hubspot.files.getOne(id, cb)

Email

hubspot.subscriptions.get(opts, cb)

Email Events

hubspot.campaigns.get(opts, cb)
hubspot.campaigns.getOne(id, appId, cb)
hubspot.campaigns.events(opts, cb)

Social Media

hubspot.broadcasts.get(opts, cb)

OAuth

Obtain your authorization url

const params = {
  client_id: 'your_client_id',
  scopes: 'some scopes',
  redirect_uri: 'take_me_to_the_ballpark'
}
const uri = hubspot.oauth.getAuthorizationUrl(params)

Obtain your authorization url

const params = {
  client_id: 'your_client_id',
  scopes: 'some scopes',
  redirect_uri: 'take_me_to_the_ballpark'
}
const uri = hubspot.oauth.getAuthorizationUrl(params)

Obtain an access token from an authorization_code

const hubspot = new Hubspot({
  clientId: '',
  clientSecret: '',
  redirectUri: ''
})
return hubspot.oauth.getAccessToken({
  code: 'abc' // the code you received from the oauth flow
}).then(...)

You can also pass the constructor directly as parameters (although with a slighlty awkward case change)

const params = {
  code: 'abc' // the code you received from the oauth flow
  client_id: '',
  client_secret: '',
  redirect_uri: ''
}
const hubspot = new Hubspot(params)
return hubspot.oauth.getAccessToken(params).then(...)

Typescript

You may use this library in your Typescript project via:

import Hubspot from 'hubspot';
const hubspot = new Hubspot({ apiKey: 'key' });

License

MIT

Contributing

Tests

Tests are written using the HubSpot API sandbox. As such, resources get added and deleted all the time. Don't harcode record values when fetching / updating / deleting (because those tend to disappear). Instead, fetch first an array of available records, then use of the returned ID in your test.

Contributors

• Brian Falk @brainflake
• Tim Atkinson @timisbusy
• Tejas Manohar @tejasmanohar
• Krispin Schulz @kr1sp1n
• Filipe Ferreira @iTsFILIPOficial
• Sam Levan @samlevan
• Paul Cothenet @pcothenet
• Nick Mason @masonator
• Mikael Puittinen @mpuittinen
• @davidmfoley
• @jayprakash1
• @alexatdivvy
• @forstermatth
• @amit777
• Stas Nikiforov @stasnikiforov