...
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| A document containing details with which to identify the data object(s) to retrieve from HubSpot. |
Output | Document |
|
| A document that contains details of the data object(s) 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 pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. |
...
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 Value: V3 | Dropdown list | Select the version of the API that you are using to use for the pipeline. | |
Category* Default Value: N/A | String/Suggestion | Select the application from which you are retrieving to retrieve the data objects. | |
Entity*
| String/Suggestion | Select the data object to read. Alternatively, click the Suggestion icon list to select the entity. | |
Action*
| String/Suggestion | Select the read-action to perform on the selected entity. Alternatively, click the Suggestion icon list to select the supported action. | |
Required Parameters | Use this field set to enable the Snap to perform a specific action. | ||
Parameter Default Value: N/A | String/Suggestion | Specify the names of the required parameters. Alternatively, click the Suggestion icon list to select the required parameter. | |
Value Default Value: N/A | 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 | String/Suggestion | Specify the names of the optional parameters. Alternatively, click the Suggestion icon list to select the parameter. | |
Value Default Value: N/A | String | Specify the values for optional parameters. The data type of this field depends on the specified parameter. | |
Connection timeout* Default Value: 30 | Integer | Specify the time in seconds for the Snap to wait before aborting terminating the request because of a failure to estabish a connection to the target service. | |
Number of retries* Default Value: 0 | Integer | Specify the maximum number of retry attempts to make if a connection failure or timeout occurs. | |
Retry interval (seconds)* Default Value: 0 | Integer | Specify the number of seconds for which the Snap must wait before attempting recovery from a network failure. | |
Snap Execution Default Value: Execute only | Dropdown list | Select one of the following three modes in which the Snap executes:
|
...
Configure the Mapper Snap to map the output details from the JSON Generator Snap to the corresponding fields in the HubSpot Platform.
...
On validating validation of the Snap, the JSON input fields are mapped to the HubSpot entity's fields as shown below:
...
Finally, the output from the Mapper snap Snap is passed on to the HubSpot Bulk Read snapSnap. The HubSpot Bulk Read Snap is configured with the Company Entity and Read a Batch of Companies action.
...