Forwarding Destination - HubSpot
  • 17 Jul 2024
  • PDF

Forwarding Destination - HubSpot

  • PDF

Article summary

summary

Help page for setting up data transfer to HubSpot.

Setting items

STEP1 Basic settings

item nameindispensabledefault valueContents
HubSpot Connection InformationYes-From the pre-registered HubSpot connection information, select the one that has the necessary permissions for this transfer setup.
Only connection information created with OAuth 2.0 as the authentication method can be selected.
object typeYes-Select the name of the object you wish to designate as the transfer destination.
List of object types
  • contact
  • company
  • deal
  • product
  • ticket
  • line_item
  • quote
  • subscription
  • call
  • email
  • meeting
  • note
  • postal_mail
  • task
  • custom object
  • transfer modeYesUPSERTSelect the data transfer method for the object.
  • UPSERT: UPSERT data against an object.
  • Append (INSERT ): Appends data to an object.
  • UPSERT keyYeshs_object_idEnter when UPSERT is selected as the transfer mode.
    Enter the name of a property that should be treated as a merge key (primary key) with no duplicate values.

    Note that the default value hs_object_id is a property with a unique value set on the HubSpot side.
    If you want to specify properties other than hs_object_id, you need to prepare them in advance on the HubSpot side.
    For details, please refer to the case where an arbitrary property is set as the UPSERT key, described below.
    Associations to ObjectsYes-Set if an engagement object is selected for the object type.
    For more information, see Associations to Objects.

    :::(Warning) (subscription object)

    If subscription is selected as the object type, the transfer is performed by UPSERT.
    In addition, the UPSERT key will automatically specify the email and subscription_id.
    For details, please refer to the case of updating the SUBSCRIPTION object described below.
    :::

    custom object

    You can also transfer data to custom objects created on HubSpot.
    Clicking on Load Custom Objects will allow you to select a custom object associated with the selected connection information.

    Associations to Objects

    HubSpot allows you to associate a record of one object with a record of another object.
    TROCCO will combine associations to existing HubSpot objects when transferring engagement objects.

    List of Engagement Objects

    The following is a list of engagement objects and the objects with which each can be associated.

    engagement objectList of objects to be associated
    callcontact, company, deal, ticket
    emailcontact, company, deal, ticket
    meetingcontact, company, deal, ticket
    notecontact, company, deal, ticket
    postal_mailcontact, company, deal, ticket
    taskcontact, company, deal, ticket, quote

    Configuration items for associations to objects

    Selecting an engagement object in the object type will display the associations to the object.

    001.png

    • object being studied
      • Select the object to be associated.
    • Unique key on HubSpot side
      • Enter a column with a unique value from the object to be associated.
    • Column name on the transfer data side
      • Enter the name of the "column to identify the record to be associated" contained in the data to be transferred.
      • When the value in the column matches the value of the unique key on the HubSpot side, an engagement is associated with the corresponding record.

    Example of setting an association to an object

    Suppose you want to transfer the following data

    hs_timestamp,hs_call_body,company_id
    2023-08-01T00:00:00.000Z,hoge,hoge@example.com,XXXXXXXXXX1
    2023-08-02T00:00:00.000Z,fuga,fuga@example.com,XXXXXXXXXX1
    2023-08-03T00:00:00.000Z,piyo,piyo@example.com,XXXXXXXXXX2
    

    Select "call" as the object type and set the following in the object association

    • Target object: company
    • Unique key on HubSpot side: hs_object_id
    • Column name on the transfer data side: company_id

    When this transfer setting is executed, the transfer data will be associated with the following records, respectively

    • Rows 1-2 of the transferred data: Records for which the value of the hs_object_id column of the company object is XXXXXXXXXXXXXX1
    • Row 3 of the transferred data: record with hs_object_id column value of XXXXXXXXXXXX2 in the company object

    supplementary information

    To set any property as the UPSERT key

    If you want to set properties other than hs_object_id or contact object email for the UPSERT key, you must do so on the HubSpot side beforehand.
    The setup procedure is described below.

    1. Log in to HubSpot and click on your current HubSpot account
    2. Click on the settings icon in the red frame in the upper right corner of the screen
      image
    3. Click Properties
      image
    4. Select the object and click on the property you want to use as the UPSERT key
      image
    5. Click on the Rules tab
      image
    6. For this property, enable the Require non-duplicate values and click Save.
      image

    To update the subscription object

    In order to update the SUBSCRIPTION object, it is necessary to map column names and types on the TROCCO.
    Refer to the table below and perform the mapping in STEP 2 "Column Definition" tab of TROCCO's Transfer Settings.

    column namedata typeindispensableInput ExampleDescription.
    emailstringhoge@example.comEmail Address
    subscription_idlong12232subscription ID
    is_subscribedbooleantrueDelivery Registration Status
  • true: true Subscribe to Delivery
  • false: false Unsubscribe
  • :::(Warning) ( Restriction on is_subscribed )

    • You cannot update data for which is_subscribed (delivery registration status) is false (has been unsubscribed ).
      If you wish to update the status of your delivery registration to the registered status, please do so on the HubSpot side of the screen.

    • Data updates to HubSpot-side data are not supported without changing the delivery registration status.
      Therefore, it is not possible to update data with is_subscribed``true for data with is_subscribed (delivery registration status) true (registered) on the HubSpot side.
      :::

    How to check your Subscription ID

    1. On the HubSpot screen, select Settings > Data Management > Properties.
    2. Select Export All Properties in the upper right corner of the Properties screen and click on the modal "Export" to download the Excel/CSV file.
    3. In the CONTACT sheet of the Excel/CSV file, look for an entry beginning with hs_email_optout_.
      Example: For hs_email_optout_111, the subscription ID is 111.

    Was this article helpful?