TIBCO Scribe® Online Connector For HubSpot

Use the TIBCO Scribe® Online Connector for HubSpot to create HubSpot source or target Connections in Integration and Migration Solutions. You can also use the HubSpot Connector to integrate Contact, Company, Deal, and Task data between HubSpot and other datastores, synchronize List and Email Campaign data, and submit Form data.

Possible use cases for the HubSpot Connector include:

Connector Specifications

  Supported

Agent Types

On Premise X
Cloud X

Replication Services

Source  
Target  

Integration Services

Source X
Target X

Migration Services

Source X
Target X

Maps

Integration X
Request-Reply X
Message  

Note: This Connector is available from the TIBCO Scribe® Online Marketplace. See Marketplace TIBCO Scribe® Certified Connectors for more information.

Supported Entities

TIBCO Scribe® Online currently supports the following entities and operations for the HubSpot connector. Select a linked entity name for additional information on using that entity with TIBCO Scribe® Online. For a list of additional operations by entity see Special Operations.

Standard Operations

Entity Query Create
Update Delete Upsert

Call

X

X

X

X

 

Company

X

X

X

X

 

Contact

X

X

X

X

X

ContactList

X

X

X

X

 

ContactListMember

 

 

 

 

 

ContactsDeals

 

X

 

X

 

CrmAssociations

X

X

 

X

 

Deal

X

X

X

X

 

DealPipeline

X

 

 

 

 

Email

X

X

X

X

 

EmailCampaign

X

 

 

 

 

EmailEvent

X

 

 

 

 

Engagement

X

 

 

X

 

Form

 

 

 

 

 

FormSubmissionInfo

 

 

 

 

 

HubSpotEvent

 

X

 

 

 

IncomingEmail

X

X

X

X

 

ListMembership

 

 

 

 

 

Meeting

X

X

X

X

 

Note

X

X

X

X

 

SubscriptionStatus

X

 

X

 

 

SubscriptionType

X

 

 

 

 

Task

X

X

X

X

 

Special Operations

Entity Operations

Company

Update/Insert

Contact

OptOut

Update/Insert

ContactListMember

Add

Remove

Deal

Update/Insert

Form

Submit

Task

Update/Insert

Setup Considerations

To use the HubSpot Connector, you need a trial, paid HubSpot Professional, or Enterprise account. For more information, see the HubSpot website.

In addition, to create and use a HubSpot Connection, you need your own HubSpot user account. If needed, ask your HubSpot Administrator to create a user account for you. Refer to How to add users to your HubSpot account in the HubSpot Knowledge Base.

Note: HubSpot OAuth tokens can become invalid if any one of the configurations below is used. Best practice is to use a single HubSpot user account and only one HubSpot Connection in TIBCO Scribe® Online per TIBCO Scribe® Online Organization.

Selecting An Agent Type For HubSpot

Refer to TIBCO Scribe® Online Agents for information on available Agent types and how to select the best Agent for your Solution.

Connecting To HubSpot

Note: Best practice is to create Connections with credentials that limit permissions in the target system, following the principle of least privilege. Using Administrator level credentials in a Connection provides Administrator level access to the target system for TIBCO Scribe® Online users. Depending on the entities supported, a TIBCO Scribe® Online user could alter user accounts in the target system.

  1. Select More > Connections from the menu.
  2. From the Connections page select Add to open the Add a New Connection dialog.
  3. Select the Connector from the drop-down list in the Connection Type field, and then enter the following information for this Connection:
    • Name — This can be any meaningful name, up to 25 characters.
    • Alias — An alias for this Connection name. The alias is generated from the Connection name, and can be up to 25 characters. The Connection alias can include letters, numbers, and underscores. Spaces and special characters are not accepted. You can change the alias. For more information, see Connection Alias.
    • Account Number — Your HubSpot account number, which you can find under My Profile in the HubSpot Settings pane.
  4. Select Authenticate to open the HubSpot authorization page:
    • If you are not already logged into HubSpot, the HubSpot login page displays. Enter your email address and password, and select Log in.
    • If this is the first time you are creating a HubSpot Connection, the HubSpot Authorization page displays. Select Authorize to allow HubSpot to use the data specified.

      A page with the following message displays:

  5. Select Close to return to the TIBCO Scribe® Online page.

    Tip: Do not test the Connection until the message at the top of the Connection dialog reads Authentication complete. Note that it may take a few minutes for this message to display.

  6. Select Test to ensure that the Agent can connect to HubSpot. Be sure to test the Connection against all Agents that use this connection. See Testing Connections.
  7. Select OK to save the Connection.

Metadata Notes

Naming

Connection metadata must have unique entity, relationship, and field names. If your Connection metadata has duplicate names, review the source system to determine if the duplicates can be renamed.

Picklists

Reserved Fields

Some HubSpot fields have reserved names that cannot be used as custom field names. Using one of these field names as a custom field name generates errors.

Contact

HubSpot Connector As IS/MS Source

Using changedate To Filter Records

When using HubSpot as a source, if you use the Most Recent Record Processed feature or filter on the changedate field in the Query Block, HubSpot may return multiple contact records for each HubSpot Contact. These records are tracked with the vid field, HubSpot contact ID. When TIBCO Scribe® Online queries the HubSpot API for records that are filtered on changedate, HubSpot returns a contact record for each unique changedate.

If you use changedate as a filter in the Net Change tab or you use no filters at all on the Filters tab, the value of changedate displays in the Preview tab and is included in the Query results. If you use any filter on the Filters tab for Contact, the value of the changedate field is blank on the Preview tab and is not included in Query results.

Note: The changedate field is called addedat in HubSpot.

Filtering On HubSpot Data

When a datetime is configured on the Query Block on the Block Properties Net Change Tab to query for new and updated records, that configuration is treated as an additional filter. The Net Change datetime filter is applied as an AND after any other filters specified on the Block Properties Filter Tab. TIBCO Scribe® Online builds a query combining both the Net Change filter and the filters on the Filter tab. See Net Change And Filters for an example.

Some Connectors for TIBCO Scribe® Online only support one filter. For those Connectors you can use either Net Change or one filter on the Filter tab, not both.

Note: The Net Change date is ignored when previewing data on the Preview tab. Filters on the Block Properties Filters tab are used to filter the data on the Preview tab.

Relationships

Note: For this Connector, only one level of relationship, Parent/Child, is supported for the entity selected in the Query or Fetch Block. For records with multiple levels of relationships, such as Parent, Child, Grandchild, only the selected Parent entity and related Child entities can be retrieved. Additional levels beneath Child entities, such as Grandchildren, cannot be accessed for this Connector using the Include tab. See Block Properties Include Tab — Relational Data.

HubSpot Connector As IS/MS Target

Special Operations

The following additional target operations are available in Integration Maps for this Connector:

Note: These operations may behave differently depending on the entity. Refer to Notes On Standard Entities below for additional information.

Notes On Standard Entities

Call

Company

Contact

ContactList

ContactListMember

ContactsDeals

CrmAssociations

Note: For Category information and ID lists refer to the following HubSpot API documentation pages:

Deal

DealPipeline

Email

EmailCampaign

EmailEvent

Engagement

Form

Using the HubSpot Connector you can submit form data to HubSpot. Forms are used in HubSpot to populate a subset of Contact fields. To use the Forms entity, enable the Marketing module in HubSpot.

FormSubmissionInfo

HubSpotEvent

Use this entity to track if and when an event was triggered by a Contact.

Note: If the Contact in the Event record does not exist in HubSpot, TIBCO Scribe® Online creates an empty Contact record with only an email address. Use the Contact entity to create new Contacts before creating Events or to update new Contacts after creating Events.

IncomingEmail

ListMembership

Meeting

Note

SubscriptionStatus

SubscriptionType

Task

TIBCO Scribe® Online API Considerations

To create connections with the TIBCO Scribe® Online API, the HubSpot Connector requires the following information:

Connector Name

HubSpot

Connector ID

84DDC45D-675E-4EBA-A781-AB1FF24985B1

TIBCO Scribe® Online Connection Properties

In addition, this Connector uses the Connection properties shown in the following table.

Note: Connection property names are case-sensitive.

Name Data Type Required Secured

PortalId

String

Yes

No

When creating or updating a HubSpot Connection with the TIBCO Scribe® Online API you must include the property PortalId, with the value of your HubSpot Account Id.

Example:

"Properties": [
{
      "Key": "PortalId",
      "Value": "2648825"
}
]

See Create Or Modify An OAuth Connection in the API Help.

License Agreement

The TIBCO Scribe® Online End User License Agreement for the HubSpot Connector describes TIBCO and your legal obligations and requirements. TIBCO suggests that you read the End User License Agreement.

More Information

For additional information on this Connector, refer to the Knowledge Base and Discussions in the TIBCO Community.