Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field Name

Field Type

Description

Label*

Default value: HubSpot Bulk Read

Example: Bulk Read Company Details

String

Specify a name for the Snap. If you have more than one of the same snaps in the pipeline, you can modify this and create a unique name.

API Version*

 

Default ValueV3
Example: V4

Dropdown list

Select the version of the API to use for the pipeline.

Category*

Default Value: N/A
Example: CRM

String/Suggestion

Select the application from which to retrieve the data objects.

Entity*

Default Value: N/A
Example: Companies

String/Suggestion

Select the data object to read. Alternatively, click the Suggestion (blue star) icon to select the entity.

Action*

Default Value: N/A
Example: Read a batch of Companies

String/Suggestion

Select the read-action to perform on the selected entity. Clicking the Suggestion (blue star) icon lists the supported actions. 

Required Parameters

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

Parameter

Default Value: N/A
Example: http://company.id

String/Suggestion

Specify the names of the required parameters. Clicking the Suggestion (blue star) icon lists the supported actions. 

Value

Default Value: N/A
Example: http://company.id

String

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

Optional Parameters

Specify the optional parameters for a specific action.

Parameter

Default Value: N/A
Example: properties

String/Suggestion

Specify the names of the optional parameters. Clicking the Suggestion (blue star) icon lists the supported actions. 

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.

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: 0
Example: 4

Integer

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

Retry interval (seconds)*

Default Value: 0
Example: 10

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 to manage the retry policy for connection and error responses from the following options. The available options are:

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

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

Snap Execution

Default ValueExecute only
Example: Validate & Execute

Dropdown list

Select one of the following three modes in which the Snap executes:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.

  • Execute only: Performs full execution of the Snap during pipeline execution without generating preview data.

  • Disabled: Disables the Snap and all Snaps that are downstream from it.

...