hubspot-api-nodejs

NodeJS v3 HubSpot API SDK(Client) files and sample apps

Sample Applications can be found in sample-apps folder

npm install @hubspot/api-client

Instantiate client

const hubspot = require('hubspot')
const hubspotClient = new hubspot.Client({ apiKey: 'abc'})

You can also authenticate via token:

const hubspotClient = new hubspot.Client({ accessToken: YOUR_ACCESS_TOKEN })

To change the base path:

const hubspotClient = new hubspot.Client({ accessToken: YOUR_ACCESS_TOKEN, basePath: 'https://some-url' })

To add custom headers to all request:

const hubspotClient = new hubspot.Client({ accessToken: YOUR_ACCESS_TOKEN, defaultHeaders: { "My-header": "test-example" } })

API Client is using Bottoleneck for implementation of Rate and Concurrent Limiting. Please note that Apps using OAuth are only subject to a limit of 100 requests every 10 seconds. Limits related to the API Add-on don't apply. Default settings for the limiter are:

{
    maxConcurrent: 5,
    minTime: 1000 / 9
 }

It's possible to turn off either Rate or Concurrent Limiting:

const hubspotClient = new hubspot.Client({ 
    accessToken: YOUR_ACCESS_TOKEN, 
    allowRateLimiting: false,
    allowConcurrentLimiting: false
})

It's possible to turn on retry for failed requests with statuses 429 or 500. To turn on/off Configurable Retries use numberOfApiCallRetries option on Client instance creation. numberOfApiCallRetries could be set to a numberfrom 0 - 6. If numberOfApiCallRetries is set to a number greater than 0 it means that if any API Call receives ISE500 this call will be retried after a delay 200 ms and if 429 (Rate limit is exceeded) is returned for "TEN_SECONDLY_ROLLING" the call will be retried after a delay 10 sec. Number of retries will not exceed numberOfApiCallRetries value.

const hubspotClient = new hubspot.Client({ 
    accessToken: YOUR_ACCESS_TOKEN, 
    numberOfApiCallRetries : NumberOfRetries.Six
})

It's possible to create client instance with Interceptors functions which would be called and awaited before request is made:

const hubspotClient = new hubspot.Client({ 
    accessToken: YOUR_ACCESS_TOKEN, 
    interceptors: [interceptorFn1, interceptorFn2]
})

All methods return a promise. The success includes the serialized to JSON body and response objects.

Obtain your authorization url

const client_id = 'your_client_id'
const redirect_uri = 'take_me_to_the_ballpark'
const scope = 'some scopes'
const uri = hubspotClient.oauth.getAuthorizationUrl(client_id, redirect_uri, scope)

Obtain an access token from an authorization_code

return hubspotClient.oauth.defaultApi.createToken(
        'authorization_code',
        code, // the code you received from the oauth flow
        REDIRECT_URI,
        CLIENT_ID,
        CLIENT_SECRET,
    ).then(...)

Not wrapped endpoint(s)

It is possible to access the hubspot request method directly, it could be handy if client doesn't have implementation for some endpoint yet. Exposed request method benefits by having all configured client params.

hubspotClient.apiRequest({
            method: 'PUT',
            path: '/some/api/not/wrapped/yet',
            body: { key: 'value' },
          })

Typescript

You may use this library in your Typescript project via:

import Client from 'hubspot';
const hubspotClient = new Client({ apiKey: YOUR_API_KEY });

License

MIT