Skip to Content

HubSpot connection

Introduction

A HubSpot connection, created using the HubSpot connector, establishes access to HubSpot. Once a connection is configured, you can create instances of HubSpot activities associated with that connection to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Important

To use the HubSpot connector, you must have a HubSpot private app, the appropriate scope permissions set, and an access token as described in HubSpot prerequisites.

Create or edit a HubSpot connection

A new HubSpot connection is created using the HubSpot connector from one of these locations:

An existing HubSpot connection can be edited from these locations:

Configure a HubSpot connection

Each user interface element of the HubSpot connection configuration screen is described below.

HubSpot connection configuration

Tip

Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Connection Name: Enter a name to use to identify the connection. The name must be unique for each HubSpot connection and must not contain forward slashes / or colons :. This name is also used to identify the HubSpot endpoint, which refers to both a specific connection and its activities.

  • Authentication Type: Select the authentication type, either API Key or OAuth 2.0.

    Note

    HubSpot API keys are deprecated, meaning authentication with a private app and OAuth 2.0 is required. For more information, see HubSpot prerequisites.

    • API Key: If API Key is selected as the authentication type, enter the API key for your public app. (Deprecated.)

    • OAuth 2.0: If OAuth 2.0 is selected as the authentication type, the Access Token field becomes visible. Enter the access token for your private app. For more information, see HubSpot prerequisites.

  • Optional Settings: Click to expand additional optional settings:

  • Test: Click to verify the connection using the provided configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

    Note

    You must have the read permission enabled for the crm.objects.owners scope in your private app. Otherwise, the HubSpot connection won't be successful.

  • Save Changes: Click to save and close the connection configuration.

  • Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

  • Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component dependencies, deletion, and removal). A message asks you to confirm that you want to delete the connection.

Next steps

After a HubSpot connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions menus in Connector basics.

These activity types are available:

  • Search: Retrieves object data from HubSpot and is intended to be used as a source in an operation.

  • Create: Creates object data in HubSpot and is intended to be used as a target in an operation.

  • Update: Updates object data in HubSpot and is intended to be used as a target in an operation.

  • Delete: Deletes object data from HubSpot and is intended to be used as a target in an operation.