HubSpot Read

In this article

Overview

Use this Snap to retrieve data objects from HubSpot. Learn more about HubSpot APIs from HubSpot Documentation.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations and Known Issues

None.

Snap Views

FormatTypeNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min: 0
  • Max: 1
  • Mapper
  • Copy
  • CSV Parser
A document containing details with which to identify the data object to retrieve from HubSpot.
Output

Document

  • Min: 1
  • Max: 1
  • HubSpot Update
  • CSV Formatter + File Writer
  • Copy

A document containing details of the data object retrieved from HubSpot.

Snap Settings

Field NameField TypeDescription

Label

Default Value: HubSpot Read
Example: 
Read Employee Details

String
Specify a name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Entity


Default Value:
N/A
Example: 
Company

String

Required. Select the data object to read.

Action


Default Value:
N/A
Example: 
Get all companies

String

Required. Select the read-action to perform on the entity selected above. Click  to see the list of supported actions. 

Required parameters



Use this field set to enable the Snap to perform a specific action.

Parameter


Default Value:
N/A
Example: 
company.id

String

Specify the names of the required parameters. Click  to see the list of supported parameters.

Value


Default Value: 
N/A
Example: 
company.id

Multiple

Specify the values of the required parameters. The data type of this field depends on the specified parameter.

Optional parameters

Specify the optional parameters for a specific action. Specify each parameter in a separate row.