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.

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab:

• Stop Pipeline Execution: Stops the current Pipeline execution if the Snap encounters an error.

• Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

• Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

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

Select the data object to read.

Action*

Default Value: N/A
Example: Get all companies

String

Select the read-action to perform on the entity selected above. Click the Suggestion icon 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 the Suggestion icon 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.

Parameter

Default Value: N/A
Example: properties

String

Specify the names of the optional parameters. Click the Suggestion icon to see the list of supported parameters.

Value

Default Value: N/A
Example:name

String

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

Filter parameters

This property enables you to filter the results from the API response based on logical operations. 

Parameter

Default Value: N/A
Example: email

String

Specify the system parameter $filter fields to be included in the output.

Operator

Default Value: Like
Example: contains

String

Specify the comparison operator for the system parameter $filter.

Value

Default Value: N/A
Example: @example.com

Multiple

Enter the values of the specified input $filter fields. The data type of this field depends on the specified parameter.

Order records by

Select the order of the specified parameters. The order types to be selected are either ascending or descending.

Parameter

Default Value: N/A
Example: city

String

Enter the parameter for which to specify the order.

Value

Default Value: ASCENDING
Example: DESCENDING

String

Select one of the following orders in which to sort the specified parameter:

• ASCENDING

• DESCENDING

Advanced options

Use this section of Snap Settings to specify options to control the number of records in the output. This section comprises the following fields:

• Output entry offset

• Output entry limit

• Automatic pagination

Output entry offset

Default Value: 0
Example: 1

Integer

Specify the number of records to skip during the read operation. Leave it empty so as not to skip any records.

Output entry limit

Default Value: 100
Example: 30

Integer

Select the number of records to fetch in the read operation. Leave it empty to retrieve the default number of records.

Automatic pagination

Default Value: Selected

Checkbox

Select this checkbox to enable the Snap to return all the records in the output. By default, the HubSpot Read Snap returns the maximum number of records per page from HubSpot based on the entity. The remaining records, if any, display in the subsequent pages.

If you deselect the Automatic pagination checkbox, the Snap returns only the records of the first page in the output.

Learn more about Usage of Automatic pagination.

Connection timeout*

Default Value: 30
Example:30

Integer

Specify the time in seconds for the Snap to wait before terminating the request because of a failure to establish a connection to the target service.

Number of retries*

Default Value: 3
Example: 3

Integer

Specify the maximum number of retry attempts to make if a connection failure or timeout occurs.

Retry interval (seconds)*

Default Value: N/A
Example: 3

Integer

Specify the number of seconds for which the Snap must wait before attempting recovery from a network failure.

Retry policy

Default Value: Connection errors
Example: Connection and API limit exceeded errors (429)

Dropdown list

Choose the retry policy for connection and error responses. The available options are:

• Connection errors: Select this option when the client fails to establish a secure connection to the server.

• Connection and API limit exceeded errors (429): Select this option when the 10-second or daily limit is exceeded.

Snap Execution

Default Value: Validate & Execute
Example: Execute only

Dropdown list

Indicates how the Snap must be executed. Available options are:

• Validate & Execute: Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.

• Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

• Disabled: Disables the Snap and, by extension, its downstream Snaps.

Missing required parameters.

There is a required parameter that was not provided.

Verify whether all required parameters are configured.

You have reached your ten secondly rolling limit.

There are too many requests to REST endpoint.

Select Connection and API limit exceeded (429) errors in the Retry Policy and adjust the values for “Number of retries” and “Retry interval”.

You have reached your daily limit.

There are too many requests to REST endpoint.

The maximum number of daily requests has been reached, and no further requests can be made until it resets. For more information refer to API Meters.