Versions Compared

Old Version 8

changes.mady.by.user Kalpana Malladi

Saved on

compared with

New Version 9

changes.mady.by.user Kalpana Malladi

Saved on

Key

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

...

Field NameField TypeDescription

Label

Default Value: HubSpot Read
Example: Read Employee Details

String
Insert excerpt
File Writer
File Writer
nopaneltrue

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.


Parameter


Default Value: N/A
Example: properties

String

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



Value

Default Value: N/A
Example:name

Multiple

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. Specify each parameter in a separate row. Click Image Removed to add a new row. This field set consists of the following fields: 

  • Parameter
  • Operator
    • Value

    Note


    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.Specify each parameter in a separate row. Click Image Removed to add a new row.

    This fieldset consists of the following fields: 

  • Parameter
    • Value

    Note

    Not all parameters support sorting. Refer to HubSpot API Documentation for more information.


    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

    Required. Enter the connection timeout duration of seconds.

    Number of retries


    Default Value:     3
    Example:     3

    		Integer

    Required. Enter the maximum number of re-connection attempts in case of a failure or timeout.

    Retry interval (seconds)


    Default Value:     N/A
    Example:     3

    		Integer

    Required. Enter the interval in seconds between reconnections attempts.

    Snap Execution


    Default Value:     Validate & Execute
    Example:     Execute only

    		String

    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.

    ...