HubSpotConnector

The callbackUrl is the endpoint that is registered in the iApp to handle the response of the authorization call. This endpoint also has to direct to the handleAuthentication process of the connector

Note:This param is now optional because it can be specified in the Authenticate or in here (config)

Your Client ID (OAuth Client ID), which identifies who you are. You can access the client_id in your app's developer dashboard under the Summary section.

Note:This param is now optional because it can be specified in the Authenticate or in here (config)

The HubSpot portal ID of the customer that you're re-directing. You will need to get the portal ID from the customer who you're making the request for.

In order to find the Hub ID follow this link: http://help.hubspot.com/articles/How_To_Doc/How-to-find-your-hub-id

Note:This param is now optional because it can be specified in the Authenticate or in here (config)

The object store to store the user credentials

The scopes (or permissions) you want. These should match your application settings in the Marketplace. Separate more than one scope with an space character "Ex:scope-a offline"

Important: the scope offline provides the ability to refresh the token automatically once this has expired. If you do not specify this scope, once the token expires the call to a process will throw a HubSpotConnectorAccessTokenExpiredException

Note: the scope required in the authentication must be supported by the application. This can be checked in the Application Settings, under Scopes

For a complete list of the available scopes check this link: http://developers.hubspot.com/auth/oauth_scopes

Note:This param is now optional because it can be specified in the Authenticate or in here (config)

Add a contact record that has already been created in the system to a contact list.

Please note that you cannot manually add (via this API call) contacts to dynamic lists - they can only be updated by the contacts app.

API link: http://developers.hubspot.com/docs/methods/lists/add_contact_to_list

/** This process generates the URL required to authenticate against the service.

Important: in order for the full authentication to work, the callbackUrl in the configuration must be pointing to another flow that has the authenticateResponse process to handle the reception of the token

This process is the one that handles the response of the authentication process. It should be inside an HTTP inbound which url must be the same that the one pointed by the callbackUrl in the configuration in order to get the access_token provided by the service.

Create a new contact in HubSpot with a simple HTTP POST to the Contacts API.

API link: http://developers.hubspot.com/docs/methods/contacts/create_contact

Create a new list in a given HubSpot portal to populate with contacts.

API link: http://developers.hubspot.com/docs/methods/lists/create_list

Create a new property in HubSpot. Properties in HubSpot are fields that have been created. By default, there are many fields that come "out of the box" in a HubSpot portal, but users can also create new, custom properties as they please.

This method enables you to create a new property. If you try to create a property whose name already exists in the system, you'll get an HTTP 409 exception thrown from the API.

Currently, there is a 1,000 property limit that you can have in any given portal.

API link: https://developers.hubspot.com/docs/methods/contacts/create_property

For a given portal, create a new contact proprerty group.

Property groups allow you to more easily manage properties in a given portal. They also let you organize the user interface of the contacts web application in a more flexible way.

There are certain propery groups that are in place for each portal by default: 'Contact Information', 'Social Media Information', 'Company Information' and 'Email Inforamtion' are examples. This method lets you create your own custom property group in a portal.

API link: https://developers.hubspot.com/docs/methods/contacts/create_group

Archive an existing contact from a particular HubSpot portal. Archiving will not hard delete a contact from a portal, but will remove that contact from the HubSpot user interface.

API link: http://developers.hubspot.com/docs/methods/contacts/delete_contact

Delete an existing property in HubSpot. This method lets you delete one of many properties of a contact in HubSpot.

To delete a contact property, you should make an HTTP DELETE call to this endpoint with the name of the property you're deleting in the request URL.

API link: https://developers.hubspot.com/docs/methods/contacts/delete_property

For a given portal, delete a contact property group based on the name of the group.

Property groups allow you to more easily manage properties in a given portal. They also let you organize the user interface of the contacts web application in a more flexible way.

There are certain property groups that are in place for each portal by default: 'Contact Information', 'Social Media Information', 'Company Information' and 'Email Inforamtion' are examples. This method lets you delete your own custom property group in a portal. You can also create new groups, update existing groups, or just get group and the properties in each group.

API link: https://developers.hubspot.com/docs/methods/contacts/delete_group

For a given portal, return all contacts that have been created in the portal. A paginated list of contacts will be returned to you, with a maximum of 100 contacts per page.

API Link: http://developers.hubspot.com/docs/methods/contacts/get_contacts

Properties in HubSpot are fields that have been created. By default, there are many fields that come "out of the box" in a HubSpot portal, but users can also create new, custom properties as they please. This method returns all of those properties to you.

API link: https://developers.hubspot.com/docs/methods/contacts/get_properties

For a given portal, return information about a single contact by its email address.

API link: http://developers.hubspot.com/docs/methods/contacts/get_contact_by_email

For a given portal, return information about a single contact by its ID. The contact's unique ID's is stored in a field called 'vid' which stands for 'visitor ID'. This method will also return you much of the HubSpot lead "intelligence" that you may be accustomed to getting from the leads API, as properties in this new API. More of this intelligence will be available as time passes, but this call is where you can expect to find it.

API link: http://developers.hubspot.com/docs/methods/contacts/get_contact

For a given portal, return information about a single contact by its User Token (hubspotutk)

API link: http://developers.hubspot.com/docs/methods/contacts/get_contact_by_utk

For a given portal, return a contact list by its unique ID.

API link: http://developers.hubspot.com/docs/methods/lists/get_list

For a given portal, return statistics about that portal's contacts.

API link: http://developers.hubspot.com/docs/methods/contacts/get_contact_statistics

For a given portal, return contacts and some data associated with those contacts by the contact's email address or name. Please note that you should expect this method to only return a small subset of data about the contact. One piece of data that the method will return is the contact ID (vid) that you can then use to look up much more data about that particular contact by its ID.

API link: http://developers.hubspot.com/docs/methods/contacts/search_contacts

For a given portal and a given list, identified by its unique ID, return a list of contacts that are in that list.

API link: http://developers.hubspot.com/docs/methods/lists/get_list_contacts

For a given portal, return a set of contact lists that you specify with the count parameter. By default, we will only return up to 20 lists to you at a time.

API link: http://developers.hubspot.com/docs/methods/lists/get_lists

For a given portal, return all contact property groups that have been created in the portal.

Property groups allow you to more easily manage properties in a given portal. They also let you organize the user interface of the contacts web application in a more flexible way.

There are certain property groups that are in place for each portal by default: 'Contact Information', 'Social Media Information', 'Company Information' and 'Email Inforamtion' are examples.

API link: https://developers.hubspot.com/docs/methods/contacts/get_groups

For a given portal, return a set of dynamic contact lists that you specify with the count parameter.

Dynamic lists are lists that can only be edited by the contacts app - they are meant to update themselves when new contacts are created or are updated, meaning that you can't manually add contacts to dynamic lists.

By default, we will only return 20 lists to you via this API call.

API link: http://developers.hubspot.com/docs/methods/lists/get_dynamic_lists

For a given portal, return all email subscription information for the given email address and portal.

API link: http://developers.hubspot.com/docs/methods/email/get_status

For a given portal, return all email subscription types that have been created in the portal.

API link: http://developers.hubspot.com/docs/methods/email/get_subscriptions

For a given portal, return all contacts that have been recently updated or created. A paginated list of contacts will be returned to you, with a maximum of 100 contacts per page, as specified by the "count" parameter.

API link: http://developers.hubspot.com/docs/methods/contacts/get_recently_updated_contacts

Check if the User has an Access Token. This indicate that this User can start calling the process of the connector without any problems

Update an existing contact in HubSpot. This method lets you update one of many fields of a contact in HubSpot.

To update a contact, you should make an HTTP POST call to this endpoint with some JSON in the request payload. This JSON should contain properties from the contact that you want to add to or update. See the sample JSON below for an example of this snippet of JSON.

If you are trying to close a contact into a customer via the API, you should be updating the 'lifecyclestage' property and setting the value of this property to 'customer'.

Remember, if a property doesn't yet exist, you can create a new custom property through the API by using the 'Create Property' method.

API link: http://developers.hubspot.com/docs/methods/contacts/update_contact

Update an existing property in HubSpot. This method lets you update one of many properties of a contact in HubSpot.T

To update a contact property, you should make an HTTP POST call to this endpoint with some JSON in the request payload. This JSON should contain property attributes that you want to add to or update. See the sample JSON below for an example of this snippet of JSON.

Remember, if a property doesn't yet exist, you can create a new custom property through the API by using the 'Create Property' method.

API link: https://developers.hubspot.com/docs/methods/contacts/update_property

For a given portal, update a contact property group.

Property groups allow you to more easily manage properties in a given portal. They also let you organize the user interface of the contacts web application in a more flexible way.

There are certain property groups that are in place for each portal by default: 'Contact Information', 'Social Media Information', 'Company Information' and 'Email Inforamtion' are examples. This method lets you update your own custom property group in a portal.

API link: https://developers.hubspot.com/docs/methods/contacts/update_group

For a given email address and portal, update the email type subscription status. NOTE: it is only possible to opt email addresses OUT of subscription and there is NO UNDO for this operation.

API link: http://developers.hubspot.com/docs/methods/email/update_status

For a given email address and portal, update the email type subscription unsuscribing from all emails NOTE: it is only possible to opt email addresses OUT of subscription and there is NO UNDO for this operation.

API link: http://developers.hubspot.com/docs/methods/email/update_status