Introduction
With COZYROC connection you can connect your HubSpot data to Microsoft SQL Server and create, sync, export or import your data to Microsoft Dynamics CRM, Zoho CRM, Salesforce, Sage, Slack, Google sheets, QuickBooks and many other services or databases supported by SQL Server Integration Services.
Overview
COZYROC SSIS+ library supports connections with HubSpot service. HubSpot service configuration file, along with our REST adapters and connection manager, work in conjunction with SSIS for establishing connections with HubSpot service. You can use any application, service or database supported by SQL Server Integration Services (SSIS) or COZYROC’s toolkit as the source or destination for HubSpot service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Manage remote files and directories
Use File Transfer Task to manage remote files and directories.
Questions
If you have any question about connections with HubSpot service, please do not hesitate to contact us.
Demonstration
Quick Start
In this task, we will show you step-by-step how to create a connection to Hubspot REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Hubspot. Then click New in the Token File parameter to create a new token file.
Step 3. Specify value for PortalId ** in the grid below. Regarding **Scope parameter please review this KB-Article. Hit Next to continue with the token generation process.
Step 4: Provide Email and Password. Then press 'Log in' button.
Step 5: In the next wizard click on Connect app
Step 6: Save generated access token to file. Specify token protection password. Click OK.
Step 7. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Hubspot instance.
In this guide, we will show how to read data from the Hubspot service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Hubspot connection from the combo. Select from available Hubspot resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select Hubspot resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Hubspot service.
In this guide, we will show how to write data to the Hubspot service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Hubspot connection from the combo. Also, select resource action and Hubspot resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Hubspot resource.
Configuration
Base URL address: https://api.hubapi.com.
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 900) * 1000}}.The authentication has the following user-defined parameters:
- PortalId:
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts/v1/lists/all/contacts/all.
The result is extracted from:{{=response.contacts}}.
The result is paginated.The following request parameters will be automatically processed:
-
vidOffset:
{{=parameters.iterator}} -
count:
{{=parameters.batchSize}} -
property:
{{=_.without(parameters.fields, 'vid', 'portal-id', 'addedAt', 'canonical-vid', 'merged-vids', 'profile-token', 'profile-url', 'identity-profiles', 'merge-audits', 'form-submissions')}}
Documentation: http://developers.hubspot.com/docs/methods/contacts/get_contacts.
-
vidOffset:
- [Read search] action
-
Endpoint URL address:
/contacts/v1/search/query.
The result is extracted from:{{=response.contacts}}.
The result is paginated.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "q").
The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
count:
{{=parameters.batchSize}} -
property:
{{=_.without(parameters.fields, 'vid', 'portal-id', 'addedAt', 'canonical-vid', 'merged-vids', 'profile-token', 'profile-url', 'identity-profiles', 'merge-audits', 'form-submissions')}} -
q:
{{=parameters.search}}
Documentation: http://developers.hubspot.com/docs/methods/contacts/search_contacts.
- [Read recent] action
-
Endpoint URL address:
/contacts/v1/lists/recently_updated/contacts/recent.
The result is extracted from:{{=response.contacts}}.
The result is paginated.The following request parameters will be automatically processed:
-
timeOffset:
{{=parameters.iterator.timeOffset}} -
vidOffset:
{{=parameters.iterator.vidOffset}} -
count:
{{=parameters.batchSize}} -
property:
{{=_.without(parameters.fields, 'vid', 'portal-id', 'addedAt', 'canonical-vid', 'merged-vids', 'profile-token', 'profile-url', 'identity-profiles', 'merge-audits', 'form-submissions')}}
Documentation: http://developers.hubspot.com/docs/methods/contacts/get_recently_updated_contacts.
-
timeOffset:
- [Read id] action
-
Endpoint URL address:
/contacts/v1/contact/vids/batch.
The result is extracted from:{{=_.toArray(response)}}.
The result is paginated.The action has the following user-defined parameters:
- id: Required. Specify comma separated list of vid.
The following request parameters will be automatically processed:
-
property:
{{=_.without(parameters.fields, 'vid', 'portal-id', 'addedAt', 'canonical-vid', 'merged-vids', 'profile-token', 'profile-url', 'identity-profiles', 'merge-audits', 'form-submissions')}} -
vid:
{{=parameters.id.split(',')}}
Documentation: http://developers.hubspot.com/docs/methods/contacts/get_batch_by_vid.
- [Read email] action
-
Endpoint URL address:
/contacts/v1/contact/emails/batch.
The result is extracted from:{{=_.toArray(response)}}.
The result is paginated.The action has the following user-defined parameters:
- email: Required. Specify comma separated list of email addresses.
The following request parameters will be automatically processed:
-
property:
{{=_.without(parameters.fields, 'vid', 'portal-id', 'addedAt', 'canonical-vid', 'merged-vids', 'profile-token', 'profile-url', 'identity-profiles', 'merge-audits', 'form-submissions')}} -
email:
{{=parameters.email.split(',')}}
Documentation: http://developers.hubspot.com/docs/methods/contacts/get_batch_by_email.
- [Read utk] action
-
Endpoint URL address:
/contacts/v1/contact/utks/batch.
The result is extracted from:{{=_.toArray(response)}}.
The result is paginated.The action has the following user-defined parameters:
- utk: Required. Specify comma separated list of utk.
The following request parameters will be automatically processed:
-
property:
{{=_.without(parameters.fields, 'vid', 'portal-id', 'addedAt', 'canonical-vid', 'merged-vids', 'profile-token', 'profile-url', 'identity-profiles', 'merge-audits', 'form-submissions')}} -
utk:
{{=parameters.utk.split(',')}}
Documentation: http://developers.hubspot.com/docs/methods/contacts/get_batch_by_utk.
- [Read company] action
-
Endpoint URL address:
/companies/v2/companies/{{=parameters.company}}/contacts.
The result is extracted from:{{=response.contacts}}.
The result is paginated.The action has the following user-defined parameters:
- company: Required. Specify company.
The following request parameters will be automatically processed:
-
vidOffset:
{{=parameters.iterator}} -
count:
{{=parameters.batchSize}} -
property:
{{=_.without(parameters.fields, 'vid', 'portal-id', 'addedAt', 'canonical-vid', 'merged-vids', 'profile-token', 'profile-url', 'identity-profiles', 'merge-audits', 'form-submissions')}}
Documentation: http://developers.hubspot.com/docs/methods/companies/get_company_contacts.
- [Read list] action
-
Endpoint URL address:
/contacts/v1/lists/{{=parameters.list}}/contacts/all.
The result is extracted from:{{=response.contacts}}.
The result is paginated.The action has the following user-defined parameters:
- list: Required. Specify list identifier.
The following request parameters will be automatically processed:
-
vidOffset:
{{=parameters.iterator}} -
count:
{{=parameters.batchSize}} -
property:
{{=_.without(parameters.fields, 'vid', 'portal-id', 'addedAt', 'canonical-vid', 'merged-vids', 'profile-token', 'profile-url', 'identity-profiles', 'merge-audits', 'form-submissions')}}
Documentation: https://developers.hubspot.com/docs/methods/lists/get_list_contacts.
- [Read list_recent] action
-
Endpoint URL address:
/contacts/v1/lists/{{=parameters.list_recent}}/contacts/recent.
The result is extracted from:{{=response.contacts}}.
The result is paginated.The action has the following user-defined parameters:
- list_recent: Required. Specify list identifier.
The following request parameters will be automatically processed:
-
timeOffset:
{{=parameters.iterator.timeOffset}} -
vidOffset:
{{=parameters.iterator.vidOffset}} -
count:
{{=parameters.batchSize}} -
property:
{{=_.without(parameters.fields, 'vid', 'portal-id', 'addedAt', 'canonical-vid', 'merged-vids', 'profile-token', 'profile-url', 'identity-profiles', 'merge-audits', 'form-submissions')}}
Documentation: https://developers.hubspot.com/docs/methods/lists/get_list_contacts_recent.
- [Create] action
-
Endpoint URL address:
/contacts/v1/contact/batch.
The result is extracted from:{{=undefined}}.The following request parameters will be automatically processed:
-
application/json:
{{=Hubspot.prepareContactBatch(batch)}}
Documentation: http://developers.hubspot.com/docs/methods/contacts/batch_create_or_update.
-
application/json:
- [Update] action
-
Endpoint URL address:
/contacts/v1/contact/batch.
The result is extracted from:{{=undefined}}.The following request parameters will be automatically processed:
-
application/json:
{{=Hubspot.prepareContactBatch(batch)}}
Documentation: http://developers.hubspot.com/docs/methods/contacts/batch_create_or_update.
-
application/json:
- [Upsert] action
-
Endpoint URL address:
/contacts/v1/contact/batch.
The result is extracted from:{{=undefined}}.The following request parameters will be automatically processed:
-
application/json:
{{=batch}}
Documentation: http://developers.hubspot.com/docs/methods/contacts/batch_create_or_update.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/contacts/v1/contact/vid/{{=item.vid}}.Documentation: http://developers.hubspot.com/docs/methods/contacts/delete_contact.
- vid
A key field. Template: Id.
Template: ShortText. The gathered value is processed with
{{=(item.properties[field.name] || {}).value}}expression.- portal-id
Template: Id. A read-only field.
- addedAt
Template: DateTime. A read-only field.
- canonical-vid
Template: Id. A read-only field.
- merged-vids
Template: LongText. A read-only field.
- profile-token
Template: ShortText. A read-only field.
- profile-url
Template: ShortText. A read-only field.
- identity-profiles
Template: LongText. A read-only field.
- merge-audits
Template: LongText. A read-only field.
- form-submissions
Data type: DT_NTEXT A read-only field.
- [External]
-
The external fields URL address:
/contacts/v2/properties.Before setting, the value is processed with
{{=Hubspot.convertToHS(field.fieldType, value)}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts/v1/lists.
The result is extracted from:{{=response.lists}}.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
count:
{{=parameters.batchSize}}
Documentation: http://developers.hubspot.com/docs/methods/lists/get_lists.
-
offset:
- [Read listId] action
-
Endpoint URL address:
/contacts/v1/lists/batch.
The result is extracted from:{{=response.lists}}.The action has the following user-defined parameters:
- listId: Required. Specify comma separated list of identifiers.
The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
count:
{{=parameters.batchSize}} -
listId:
{{=parameters.listId.split(',')}}
Documentation: http://developers.hubspot.com/docs/methods/lists/get_batch_lists.
- [Read listType] action
-
Endpoint URL address:
/contacts/v1/lists/{{=parameters.listType}}.
The result is extracted from:{{=response.lists}}.The action has the following user-defined parameters:
- listType: Required. Specify list type.
The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
count:
{{=parameters.batchSize}}
Documentation: http://developers.hubspot.com/docs/methods/lists/get_static_lists http://developers.hubspot.com/docs/methods/lists/get_dynamic_lists .
- [Create] action
-
Endpoint URL address:
/contacts/v1/lists.Documentation: http://developers.hubspot.com/docs/methods/lists/create_list.
- [Update] action
-
Endpoint URL address:
/contacts/v1/lists/{{=item.listId}}.Documentation: http://developers.hubspot.com/docs/methods/lists/update_list.
- [Delete] action
-
Endpoint URL address:
/contacts/v1/lists/{{=item.listId}}.Documentation: http://developers.hubspot.com/docs/methods/lists/delete_list.
- listId
A key field. Template: Id.
- name
Template: ShortText.
- dynamic
Data type: DT_BOOL
- portalId
Template: Id.
- filters
Template: LongText. A composite field.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- listType
Template: ShortText. A read-only field.
- internalListId
Template: Id. A read-only field.
- deleteable
Data type: DT_BOOL A read-only field.
- metaData
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: size, error, processing, lastProcessingStateChangeAt, lastSizeChangeAt.
-
Uses template:
- addContacts
Template: LongText. A composite field. The value is sent to
/contacts/v1/lists/{{=item.listId}}/addaddress.- removeContacts
Template: LongText. A composite field. The value is sent to
/contacts/v1/lists/{{=item.listId}}/removeaddress.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/forms/v2/forms.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
Documentation: http://developers.hubspot.com/docs/methods/forms/v2/get_forms.
-
offset:
- [Create] action
-
Endpoint URL address:
/forms/v2/forms.Documentation: http://developers.hubspot.com/docs/methods/forms/v2/create_form.
- [Update] action
-
Endpoint URL address:
/forms/v2/forms/{{=item.guid}}.Documentation: http://developers.hubspot.com/docs/methods/forms/v2/update_form.
- [Delete] action
-
Endpoint URL address:
/forms/v2/forms/{{=item.guid}}.Documentation: http://developers.hubspot.com/docs/methods/forms/v2/delete_form.
- guid
A key field. Data type: DT_GUID
- portalId
Template: Id.
- name
Template: ShortText.
- action
Template: ShortText.
- method
Template: ShortText.
- cssClass
Template: ShortText.
- redirect
Template: ShortText.
- fields
Field components:
- An array.
- Contains the following components: name, label, type, fieldType, description, groupName, displayOrder, required, selectedOptions, options, validation, enabled, hidden, defaultValue, isSmartField, unselectedLabel, placeholder, dependentFieldFilters, labelHidden.
- submitText
Template: ShortText.
- followUpId
Template: Id.
- notifyRecipients
Template: ShortText.
- leadNurturingCampaignId
Template: Id.
- formFieldGroups
Field components:
- An array.
- Contains the following components: name, fieldNames, default.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- performableHtml
Template: LongText.
- migratedFrom
Template: ShortText.
- ignoreCurrentValues
Data type: DT_BOOL
- metaData
Field components:
- An array.
- Contains the following components: name, value, includeInSubmission.
- deletable
Data type: DT_BOOL A read-only field.
- inlineMessage
Template: ShortText.
- socialLoginEnabled
Data type: DT_BOOL A read-only field.
- socialLoginTypes
Template: LongText. A read-only field. A composite field.
- tmsId
Template: Id. A read-only field.
- captchaEnabled
Data type: DT_BOOL A read-only field.
- campaignGuid
Data type: DT_GUID A read-only field.
- embeddedCode
Template: LongText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/forms/v2/fields/{{=parameters.form}}.The action has the following user-defined parameters:
- form: Required. specify form identifier.
- description
Template: ShortText.
- defaultValue
Template: ShortText.
- required
Data type: DT_BOOL
- enabled
Data type: DT_BOOL
- isSmartField
Data type: DT_BOOL
- label
Template: ShortText.
- groupName
Template: ShortText.
- selectedOptions
Template: LongText. A composite field.
- fieldType
Template: ShortText.
- hidden
Data type: DT_BOOL
- validation
Field components:
-
Uses template:
ShortText. - Contains the following components: name, message, data, useDefaultBlockList, blockedEmailAddresses.
-
Uses template:
- type
Template: ShortText.
- options
Field components:
- An array.
-
Uses template:
option.
- displayOrder
Data type: DT_I4
- name
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/form-integrations/v1/submissions/forms/{{=parameters.form}}.
The result is extracted from:{{=response.results}}.
The result is paginated.The action has the following user-defined parameters:
- form: Required. specify form identifier.
The following request parameters will be automatically processed:
-
after:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
- submittedAt
Template: DateTime.
- [External]
-
The external fields URL address:
/forms/v2/fields/{{=parameters.form}}.- {{=external.name}}
Data type: {{=Hubspot.getDataType(external.type)}} ( length {{=250}} ) The gathered value is processed with
{{=Hubspot.convertToJS(field.fieldType, value)}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/automation/v3/workflows.
The result is extracted from:{{=response.workflows}}.Documentation: http://developers.hubspot.com/docs/methods/workflows/v3/get_workflows.
- [Read contactid] action
-
Endpoint URL address:
/automation/v2/workflows/enrollments/contacts/{{=parameters.contactid}}.
The result is extracted from:{{=response.workflows}}.The action has the following user-defined parameters:
- contactid: Required. Specify contact identifier.
Documentation: http://developers.hubspot.com/docs/methods/workflows/current_enrollments.
- [Create] action
-
Endpoint URL address:
/automation/v3/workflows.Documentation: http://developers.hubspot.com/docs/methods/workflows/v3/create_workflow.
- [Delete] action
-
Endpoint URL address:
/automation/v3/workflows/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/workflows/v3/delete_workflow.
- id
A key field. Template: Id.
- name
Template: ShortText.
- type
Template: ShortText.
- enabled
Data type: DT_BOOL
- updatedAt
Template: DateTime. A read-only field.
- insertedAt
Template: DateTime. A read-only field.
- lastUpdatedBy
Template: ShortText. A read-only field.
- canEnrollFromSalesforce
Data type: DT_BOOL
- eventAnchor
Template: ShortText.
- staticDateAnchor
Template: ShortText.
- contactPropertyAnchor
Template: ShortText.
- suppressionSetting
Template: ShortText.
- goalListIds
Template: ShortText.
- listening
Data type: DT_BOOL
- originalAuthorUserId
Template: Id.
- recurringSetting
Template: ShortText.
- suppressionListIds
Template: LongText. A composite field.
- contactListIds
Field components:
-
Uses template:
ShortText. - Contains the following components: active, enrolled, steps.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/companies/v2/companies/paged.
The result is extracted from:{{=response.companies}}.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
properties:
{{=parameters.fields}}
Documentation: https://developers.hubspot.com/docs/methods/companies/get-all-companies.
-
offset:
- [Read modified] action
-
Endpoint URL address:
/companies/v2/companies/recent/modified.
The result is extracted from:{{=response.results}}.The action has the following user-defined parameters:
- modified: Required. Specify modified since.
The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
count:
{{=parameters.batchSize}} -
since:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.modified)}}
Documentation: http://developers.hubspot.com/docs/methods/companies/get_companies_modified.
- [Read created] action
-
Endpoint URL address:
/companies/v2/companies/recent/created.
The result is extracted from:{{=response.results}}.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
count:
{{=parameters.batchSize}}
Documentation: http://developers.hubspot.com/docs/methods/companies/get_companies_created.
-
offset:
- [Read domain] action
-
Endpoint URL address:
/companies/v2/companies/domain/{{=parameters.domain}}.
The result is extracted from:{{=response.results}}.The action has the following user-defined parameters:
- domain: Required. Specify domain.
The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
count:
{{=parameters.batchSize}}
Documentation: http://developers.hubspot.com/docs/methods/companies/get_companies_by_domain.
- [Create] action
-
Endpoint URL address:
/companies/v2/companies.Documentation: http://developers.hubspot.com/docs/methods/companies/create_company.
- [Update] action
-
Endpoint URL address:
/companies/v2/companies/{{=item.companyId}}.
The action uses PUT method.Documentation: http://developers.hubspot.com/docs/methods/companies/update_company.
- [Delete] action
-
Endpoint URL address:
/companies/v2/companies/{{=item.companyId}}.Documentation: http://developers.hubspot.com/docs/methods/companies/delete_company.
- companyId
A key field. Template: Id.
- portalId
Template: Id.
- isDeleted
Data type: DT_BOOL A read-only field.
- [External]
-
The external fields URL address:
/companies/v2/properties.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/crm-associations/v1/associations.
The action uses PUT method.Documentation: https://developers.hubspot.com/docs/methods/crm-associations/associate-objects.
- [Delete] action
-
Endpoint URL address:
/crm-associations/v1/associations/delete.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://developers.hubspot.com/docs/methods/crm-associations/delete-association.
-
application/json:
- fromObjectId
Template: Id.
- toObjectId
Template: Id.
- category
Template: ShortText.
- definitionId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/deals/v1/deal/paged.
The result is extracted from:{{=response.deals}}.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
properties:
{{=parameters.fields}}
Documentation: https://developers.hubspot.com/docs/methods/deals/get-all-deals.
-
offset:
- [Read modified] action
-
Endpoint URL address:
/deals/v1/deal/recent/modified.
The result is extracted from:{{=response.results}}.The action has the following user-defined parameters:
- modified: Required. Specify modified since.
The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
count:
{{=parameters.batchSize}} -
since:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.modified)}}
Documentation: http://developers.hubspot.com/docs/methods/deals/get_deals_modified.
- [Read created] action
-
Endpoint URL address:
/deals/v1/deal/recent/created.
The result is extracted from:{{=response.results}}.The action has the following user-defined parameters:
- created: Required. Specify created since.
The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
count:
{{=parameters.batchSize}} -
since:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.created)}}
Documentation: http://developers.hubspot.com/docs/methods/deals/get_deals_created.
- [Create] action
-
Endpoint URL address:
/deals/v1/deal.Documentation: http://developers.hubspot.com/docs/methods/deals/create_deal.
- [Update] action
-
Endpoint URL address:
/deals/v1/deal/{{=item.dealId}}.Documentation: http://developers.hubspot.com/docs/methods/deals/update_deal.
- [Delete] action
-
Endpoint URL address:
/deals/v1/deal/{{=item.dealId}}.Documentation: http://developers.hubspot.com/docs/methods/deals/delete_deal.
- dealId
A key field. Template: Id.
- portalId
Template: Id.
- isDeleted
Data type: DT_BOOL A read-only field.
- associations
Field components:
-
Uses template:
LongText. - Contains the following components: associatedVids, associatedCompanyIds, associatedDealIds.
-
Uses template:
- [External]
-
The external fields URL address:
/deals/v1/properties.Before setting, the value is processed with
{{=Hubspot.convertToHS(field.fieldType, value)}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/engagements/v1/engagements/paged.
The result is extracted from:{{=response.results}}.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
Documentation: https://developers.hubspot.com/docs/methods/engagements/get-all-engagements.
-
offset:
- [Read single] action
-
Endpoint URL address:
/engagements/v1/engagements/{{=parameters.id}}.The action has the following user-defined parameters:
- id: Required. Specify engagement identifier.
Documentation: http://developers.hubspot.com/docs/methods/engagements/get_engagement.
- [Read modified] action
-
Endpoint URL address:
/engagements/v1/engagements/recent/modified.
The result is extracted from:{{=response.results}}.The action has the following user-defined parameters:
- modified: Required. Specify modified since.
The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
count:
{{=parameters.batchSize}} -
since:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.modified)}}
Documentation: https://developers.hubspot.com/docs/methods/engagements/get-recent-engagements.
- [Create] action
-
Endpoint URL address:
/engagements/v1/engagements.Documentation: http://developers.hubspot.com/docs/methods/engagements/create_engagement.
- [Update] action
-
Endpoint URL address:
/engagements/v1/engagements/{{=item.engagement.uid}}.Documentation: http://developers.hubspot.com/docs/methods/engagements/update_engagement.
- [Delete] action
-
Endpoint URL address:
/engagements/v1/engagements/{{=item.engagement.uid}}.Documentation: http://developers.hubspot.com/docs/methods/engagements/delete-engagement.
- engagement
Field components:
-
Uses template:
Id. - Contains the following components: uid, type, ownerId, active, portalId, timestamp.
-
Uses template:
- associations
Field components:
-
Uses template:
LongText. - Contains the following components: contactIds, companyIds, dealIds, ownerIds.
-
Uses template:
- metadata
Field components:
-
Uses template:
LongText. - Contains the following components: body.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/crm/v3/owners.
The result is extracted from:{{=response.results}}.
The result is paginated.The following request parameters will be automatically processed:
-
after:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
Documentation: http://developers.hubspot.com/docs/methods/owners/get_owners.
-
after:
- [Create] action
-
Endpoint URL address:
/owners/v2/owners.Documentation: http://developers.hubspot.com/docs/methods/owners/create_owner.
- [Update] action
-
Endpoint URL address:
/owners/v2/owners/{{=item.ownerId}}.Documentation: http://developers.hubspot.com/docs/methods/owners/update_owner.
- id
A key field. Template: Id.
- firstName
Template: ShortText.
- lastName
Template: ShortText.
Template: ShortText.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- archived
Data type: DT_BOOL
- teams
Field components:
- An array.
- Contains the following components: id, name, primary.
- userId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/integrations/v1/{{=parameters.applicationId}}/timeline/event-types.
The result is extracted from:{{=response}}.Documentation: http://developers.hubspot.com/docs/methods/timeline/get-event-types.
- [Create] action
-
Endpoint URL address:
/integrations/v1/{{=item.applicationId}}/timeline/event-types.Documentation: http://developers.hubspot.com/docs/methods/timeline/create-event-type.
- [Update] action
-
Endpoint URL address:
/integrations/v1/{{=item.applicationId}}/timeline/event-types/{{=item.id}}.
The action uses PUT method.Documentation: http://developers.hubspot.com/docs/methods/timeline/update-event-type.
- [Delete] action
-
Endpoint URL address:
/integrations/v1/{{=item.applicationId}}/timeline/event-types/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/timeline/delete-event-type.
- id
A key field. Template: Id.
- name
Template: ShortText.
- headerTemplate
Template: LongText.
- detailTemplate
Template: LongText.
- objectType
Template: ShortText.
- applicationId
A key field. Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/email/public/v1/subscriptions/timeline.
The result is extracted from:{{=response.timeline}}.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
startTimestamp:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('startTimestamp'))}} -
endTimestamp:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('endTimestamp'))}}
Documentation: http://developers.hubspot.com/docs/methods/email/get_subscriptions_timeline.
-
offset:
- timestamp
Template: DateTime.
- portalId
Template: Id.
- recipient
Template: ShortText.
- changes
Data type: DT_WSTR ( length 4000 )
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/email/public/v1/campaigns/by-id.
The result is extracted from:{{=response.campaigns}}.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
Documentation: http://developers.hubspot.com/docs/methods/email/get_campaigns_by_id.
-
offset:
- [Read recent] action
-
Endpoint URL address:
/email/public/v1/campaigns.
The result is extracted from:{{=response.campaigns}}.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
Documentation: http://developers.hubspot.com/docs/methods/email/get_campaigns.
-
offset:
- id
A key field. Template: Id.
- appId
Template: Id.
- appName
Template: ShortText.
- lastUpdatedTime
Template: DateTime.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/email/public/v1/events.
The result is extracted from:{{=response.events}}.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
startTimestamp:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('startTimestamp'))}} -
endTimestamp:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('endTimestamp'))}}
Documentation: http://developers.hubspot.com/docs/methods/email/get_events.
-
offset:
- id
A key field. Data type: DT_GUID
- portalId
Template: Id.
- type
Template: ShortText.
- recipient
Template: ShortText.
- appId
Template: Id.
- appName
Template: ShortText.
- userAgent
Template: ShortText.
- browser
Field components:
-
Uses template:
ShortText. - Contains the following components: name, type, url, family, producer, producerUrl, version.
-
Uses template:
- created
Template: DateTime.
- emailCampaignId
Template: Id.
- hmid
Template: ShortText.
- ipAddress
Template: ShortText.
- location
Field components:
-
Uses template:
ShortText. - Contains the following components: city, state, country, latitude, longitude.
-
Uses template:
- sentBy
Field components:
-
Uses template:
DateTime. - Contains the following components: id, created.
-
Uses template:
- smtpId
Template: ShortText.
- sendId
Template: ShortText.
- subject
Template: ShortText.
- response
Template: LongText.
Based on resource template Event.
- [Read] action
-
Endpoint URL address:
/calendar/v1/events.Documentation: http://developers.hubspot.com/docs/methods/calendar/list-events.
Based on resource template Event.
- [Read] action
-
Endpoint URL address:
/calendar/v1/events/content.Documentation: http://developers.hubspot.com/docs/methods/calendar/list-content-events.
Based on resource template Event.
- [Read] action
-
Endpoint URL address:
/calendar/v1/events/social.Documentation: http://developers.hubspot.com/docs/methods/calendar/list-social-events.
Based on resource template Event.
- [Read] action
-
Endpoint URL address:
/calendar/v1/events/task.Documentation: http://developers.hubspot.com/docs/methods/calendar/list-tasks.
- [Create] action
-
Endpoint URL address:
/calendar/v1/events/task.Documentation: http://developers.hubspot.com/docs/methods/calendar/create-task.
- [Update] action
-
Endpoint URL address:
/calendar/v1/events/task/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/calendar/update-task.
- [Delete] action
-
Endpoint URL address:
/calendar/v1/events/task/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/calendar/delete-task.
Based on resource template Content.
- [Read] action
-
Endpoint URL address:
/content/api/v2/blogs.
- name
Template: ShortText.
- portal_id
Template: Id.
- allow_comments
Data type: DT_BOOL
- attached_stylesheets
Template: LongText. A composite field.
- captcha_after_days
Data type: DT_I4
- captcha_always
Data type: DT_BOOL
- close_comments_older
Data type: DT_I4
- comment_date_format
Template: ShortText.
- comment_form_guid
Data type: DT_GUID
- comment_max_thread_depth
Data type: DT_I4
- comment_moderation
Data type: DT_BOOL
- comment_notification_emails
Template: LongText. A composite field.
- comment_should_create_contact
Data type: DT_BOOL
- comment_verification_text
Template: ShortText.
- daily_notification_email_id
Template: Id.
- default_group_style_id
Template: Id.
- description
Template: ShortText.
- domain
Template: ShortText.
- domain_when_published
Template: ShortText.
- email_api_subscription_id
Template: Id.
- enable_social_auto_publishing
Data type: DT_BOOL
- header
Template: LongText.
- html_footer
Template: LongText.
- html_footer_is_shared
Data type: DT_BOOL
- html_head
Template: LongText.
- html_head_is_shared
Data type: DT_BOOL
- html_keywords
Template: LongText. A composite field.
- html_title
Template: ShortText.
- instant_notification_email_id
Template: Id.
- item_layout_id
Template: Id.
- item_template_is_shared
Data type: DT_BOOL
- item_template_path
Template: ShortText.
- language
Template: ShortText.
- legacy_guid
Data type: DT_GUID
- legacy_module_id
Template: Id.
- legacy_tab_id
Template: Id.
- listing_layout_id
Template: Id.
- listing_template_path
Template: ShortText.
- month_filter_format
Template: ShortText.
- monthly_notification_email_id
Template: Id.
- post_html_footer
Template: LongText.
- post_html_head
Template: LongText.
- posts_per_listing_page
Data type: DT_I4
- posts_per_rss_feed
Data type: DT_I4
- public_title
Template: ShortText.
- publish_date_format
Template: ShortText.
- root_url
Template: ShortText.
- rss_custom_feed
Template: ShortText.
- rss_description
Template: ShortText.
- rss_item_footer
Template: LongText.
- rss_item_header
Template: LongText.
- show_social_link_facebook
Data type: DT_BOOL
- show_social_link_google_plus
Data type: DT_BOOL
- show_social_link_linkedin
Data type: DT_BOOL
- show_social_link_twitter
Data type: DT_BOOL
- show_summary_in_emails
Data type: DT_BOOL
- show_summary_in_listing
Data type: DT_BOOL
- show_summary_in_rss
Data type: DT_BOOL
- slug
Template: ShortText.
- social_account_twitter
Template: ShortText.
- social_publishing_slug
Template: ShortText.
- social_sharing_delicious
Template: ShortText.
- social_sharing_digg
Template: ShortText.
- social_sharing_email
Template: ShortText.
- social_sharing_facebook_like
Template: ShortText.
- social_sharing_facebook_send
Template: ShortText.
- social_sharing_googlebuzz
Template: ShortText.
- social_sharing_googleplusone
Template: ShortText.
- social_sharing_linkedin
Template: ShortText.
- social_sharing_reddit
Template: ShortText.
- social_sharing_stumbleupon
Template: ShortText.
- social_sharing_twitter
Template: ShortText.
- social_sharing_twitter_account
Template: ShortText.
- subscription_contacts_property
Template: ShortText.
- subscription_email_type
Template: ShortText.
- subscription_form_guid
Data type: DT_GUID
- subscription_lists_by_type
Field components:
- Contains the following components: monthly, instant, daily, weekly.
- use_featured_image_in_summary
Data type: DT_BOOL
- weekly_notification_email_id
Template: Id.
Based on resource template Content.
- [Read] action
-
Endpoint URL address:
/content/api/v2/blog-posts.Documentation: http://developers.hubspot.com/docs/methods/blogv2/get_blog_posts.
- [Create] action
-
Endpoint URL address:
/content/api/v2/blog-posts.Documentation: http://developers.hubspot.com/docs/methods/blogv2/post_blog_posts.
- [Update] action
-
Endpoint URL address:
/content/api/v2/blog-posts/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/blogv2/put_blog_posts_blog_post_id.
- [Delete] action
-
Endpoint URL address:
/content/api/v2/blog-posts/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/blogv2/delete_blog_posts_blog_post_id.
- name
Template: ShortText.
- portal_id
Template: Id.
- blog_author_id
Template: Id.
- campaign
Data type: DT_GUID
- campaign_name
Template: ShortText.
- content_group_id
Template: Id.
- featured_image
Template: ShortText.
- use_featured_image
Data type: DT_BOOL
- footer_html
Template: LongText.
- head_html
Template: LongText.
- meta_description
Template: LongText.
- post_body
Data type: DT_WSTR ( length 4000 )
- post_summary
Data type: DT_WSTR ( length 4000 )
- publish_date
Template: DateTime.
- publish_immediately
Data type: DT_BOOL
- slug
Template: ShortText.
- topic_ids
Template: LongText. A composite field.
- widgets
Field components:
- Contains the following components: blog_comments.
- analytics_page_id
Template: Id. A read-only field.
- archived
Data type: DT_BOOL A read-only field.
- attached_stylesheets
Template: LongText. A read-only field. A composite field.
- author_user_id
Template: Id. A read-only field.
- blog_author
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: username, bio, twitter, updated, linkedin, facebook, full_name, deleted_at, slug, portal_id, user_id, created, gravatar_url, google_plus, id, website, avatar, email.
-
Uses template:
- blueprint_type_id
Template: Id. A read-only field.
- category_id
Template: Id. A read-only field.
- cloned_from
Template: ShortText. A read-only field.
- comment_count
Data type: DT_I4 A read-only field.
- css
Template: LongText. A read-only field.
- css_text
Template: LongText. A read-only field.
- domain
Template: ShortText. A read-only field.
- enable_domain_stylesheets
Data type: DT_BOOL A read-only field.
- enable_layout_stylesheets
Data type: DT_BOOL A read-only field.
- flex_areas
Template: LongText. A read-only field.
- folder_id
Template: Id. A read-only field.
- freeze_date
Template: DateTime. A read-only field.
- html_title
Template: ShortText. A read-only field.
- include_default_custom_css
Template: ShortText. A read-only field.
- is_draft
Data type: DT_BOOL A read-only field.
- is_instant_email_enabled
Data type: DT_BOOL A read-only field.
- is_social_publishing_enabled
Data type: DT_BOOL A read-only field.
- keywords
Template: LongText. A read-only field. A composite field.
- last_edit_session_id
Template: Id. A read-only field.
- last_edit_update_id
Template: Id. A read-only field.
- legacy_blog_tabid
Template: Id. A read-only field.
- meta_keywords
Template: ShortText. A read-only field.
- page_expiry_date
Template: DateTime. A read-only field.
- page_expiry_enabled
Data type: DT_BOOL A read-only field.
- page_expiry_redirect_id
Template: Id. A read-only field.
- page_expiry_redirect_url
Template: ShortText. A read-only field.
- page_redirected
Template: ShortText. A read-only field.
- performable_url
Template: ShortText. A read-only field.
- personas
Template: LongText. A read-only field.
- preview_image_src
Template: ShortText. A read-only field.
- preview_key
Template: ShortText. A read-only field.
- processing_status
Template: ShortText. A read-only field.
- published_url
Template: ShortText. A read-only field.
- rss_body
Template: LongText. A read-only field.
- rss_email_by_text
Template: ShortText. A read-only field.
- rss_email_click_through_text
Template: ShortText. A read-only field.
- rss_email_comment_text
Template: ShortText. A read-only field.
- rss_email_image_max_width
Data type: DT_I4 A read-only field.
- rss_summary
Template: ShortText. A read-only field.
- scheduled_update_date
Template: DateTime. A read-only field.
- staged_from
Template: ShortText. A read-only field.
- state
Template: ShortText. A read-only field.
- style_override_id
Template: Id. A read-only field.
- subcategory
Template: ShortText. A read-only field.
- tms_id
Template: Id. A read-only field.
- unpublished_at
Template: DateTime. A read-only field.
- url
Template: ShortText. A read-only field.
- widget_containers
Template: LongText. A read-only field. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/comments/v3/comments.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
Documentation: http://developers.hubspot.com/docs/methods/comments/get_comments.
-
offset:
- [Create] action
-
Endpoint URL address:
/comments/v3/comments.Documentation: http://developers.hubspot.com/docs/methods/comments/post_comments.
- [Delete] action
-
Endpoint URL address:
/comments/v3/comments/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/comments/delete_comments_comment_id.
- id
A key field. Template: Id.
- portalId
Template: Id.
- comment
Template: LongText.
- contentId
Template: Id.
- collectionId
Template: Id.
- contentAuthorEmail
Template: ShortText.
- contentAuthorName
Template: ShortText.
- contentPermalink
Template: ShortText.
- userEmail
Template: ShortText.
- userName
Template: ShortText.
- userUrl
Template: ShortText.
- contentTitle
Template: ShortText.
- createdAt
Template: DateTime.
- deletedAt
Template: DateTime.
- firstName
Template: ShortText.
- lastName
Template: ShortText.
- state
Template: ShortText.
- userIp
Template: ShortText.
- userReferrer
Template: ShortText.
- userAgent
Template: ShortText.
- contentCreatedAt
Template: DateTime.
- threadId
Template: ShortText.
- replyingTo
Template: ShortText.
- parentId
Template: Id.
- legacyId
Template: Id.
- extraContext
Template: ShortText.
- parent
A read-only field. Field components:
-
Uses template:
Id. - Contains the following components: id, portalId, contentId, contentTitle, contentPermalink, collectionId, createdAt, deletedAt, userName, firstName, lastName, userEmail, comment, userUrl, state, userIp, userReferrer, userAgent, contentAuthorEmail, contentAuthorName, contentCreatedAt, threadId, replyingTo, parentId, legacyId, extraContext, parent.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/blogs/v3/blog-authors.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
created:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('created'))}} -
updated:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('updated'))}}
Documentation: http://developers.hubspot.com/docs/methods/blog/v3/list-blog-authors.
-
offset:
- [Read search] action
-
Endpoint URL address:
/blogs/v3/blog-authors/search.
The result is paginated.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "q").
The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
created:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('created'))}} -
updated:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('updated'))}} -
q:
{{=parameters.search}}
Documentation: http://developers.hubspot.com/docs/methods/blog/v3/search-blog-authors.
- [Create] action
-
Endpoint URL address:
/blogs/v3/blog-authors.Documentation: http://developers.hubspot.com/docs/methods/blog/v3/create-blog-author.
- [Update] action
-
Endpoint URL address:
/blogs/v3/blog-authors/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/blog/v3/update-blog-author.
- [Delete] action
-
Endpoint URL address:
/blogs/v3/blog-authors/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/blog/v3/delete-blog-author.
- id
A key field. Template: Id.
- portalId
Template: Id.
Template: ShortText.
- fullName
Template: ShortText.
- userId
Template: Id.
- username
Template: ShortText.
- bio
Template: LongText.
- website
Template: ShortText.
Template: ShortText.
Template: ShortText.
Template: ShortText.
- googlePlus
Template: ShortText.
- avatar
Template: ShortText.
- created
Template: DateTime. A read-only field.
- updated
Template: DateTime. A read-only field.
- deletedAt
Template: DateTime. A read-only field.
- displayName
Template: ShortText. A read-only field.
- gravatarUrl
Template: ShortText. A read-only field.
- hasSocialProfiles
Data type: DT_BOOL A read-only field.
- slug
Template: ShortText. A read-only field.
- twitterUsername
Template: ShortText. A read-only field.
- livePosts
Data type: DT_I4 A read-only field.
- publicUrl
Template: ShortText. A read-only field.
- status
Template: ShortText. A read-only field.
- totalPosts
Data type: DT_I4 A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/blogs/v3/topics.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
created:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('created'))}}
Documentation: http://developers.hubspot.com/docs/methods/blog/v3/list-blog-topics.
-
offset:
- [Read search] action
-
Endpoint URL address:
/blogs/v3/topics/search.
The result is paginated.The action has the following user-defined parameters:
- search: Required. Specify search query (alias for "q").
The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
created:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('created'))}} -
q:
{{=parameters.search}}
Documentation: http://developers.hubspot.com/docs/methods/blog/v3/search-blog-topics.
- [Create] action
-
Endpoint URL address:
/blogs/v3/topics.Documentation: http://developers.hubspot.com/docs/methods/blog/v3/create-blog-topic.
- [Update] action
-
Endpoint URL address:
/blogs/v3/topics/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/blog/v3/update-topic.
- [Delete] action
-
Endpoint URL address:
/blogs/v3/topics/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/blog/v3/delete-blog-topic.
- id
A key field. Template: Id.
- portalId
Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- created
Template: DateTime. A read-only field.
- updated
Template: DateTime. A read-only field.
- deletedAt
Template: DateTime. A read-only field.
- slug
Template: ShortText. A read-only field.
- associatedBlogIds
Template: LongText. A read-only field.
- livePosts
Data type: DT_I4 A read-only field.
- status
Template: ShortText. A read-only field.
- totalPosts
Data type: DT_I4 A read-only field.
Based on resource template Content.
- [Read] action
-
Endpoint URL address:
/content/api/v4/domains.
- portalId
Template: Id.
- actualIp
Template: ShortText.
- addedToWaf
Data type: DT_BOOL
- consecutiveNonResolvingCount
Data type: DT_I4
- deletable
Data type: DT_BOOL
- domain
Template: ShortText.
- isAnyPrimary
Data type: DT_BOOL
- isDnsCorrect
Data type: DT_BOOL
- isInternalDomain
Data type: DT_BOOL
- isLegacy
Data type: DT_BOOL
- isLegacyDomain
Data type: DT_BOOL
- isResolving
Data type: DT_BOOL
- isSslEnabled
Data type: DT_BOOL
- isSslOnly
Data type: DT_BOOL
- manuallyMarkedAsResolving
Data type: DT_BOOL
- markSslOnlyAfterProvisioning
Data type: DT_BOOL
- primaryBlog
Data type: DT_BOOL
- primaryBlogPost
Data type: DT_BOOL
- primaryClickTracking
Data type: DT_BOOL
- primaryEmail
Data type: DT_BOOL
- primaryLandingPage
Data type: DT_BOOL
- primaryLegacyPage
Data type: DT_BOOL
- primarySitePage
Data type: DT_BOOL
- secondaryToDomain
Template: ShortText.
- siteId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/filemanager/api/v2/files.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
created:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('created'))}} -
deleted_at:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('deleted_at'))}} -
folder_id:
{{=Hubspot.getFolderId(parameters.get('folder_id'))}}
Documentation: http://developers.hubspot.com/docs/methods/files/get_files.
-
offset:
- [Create] action
-
Endpoint URL address:
/filemanager/api/v2/files/upload.
The result is extracted from:{{=response.objects[0]}}.The following request parameters will be automatically processed:
-
application/json:
-
fileName:
{{=item.name}} -
file:
{{=item.file}} -
folderPath:
{{=item.folder_path}} -
options:
{{=JSON.stringify(item.options)}}
Documentation: http://developers.hubspot.com/docs/methods/files/post_files.
-
application/json:
- [Update] action
-
Endpoint URL address:
/filemanager/api/v3/files/{{=item.id}}/replace.
The result is extracted from:{{=response.objects[0]}}.The following request parameters will be automatically processed:
-
application/json:
-
files:
{{=item.file}} -
options:
{{=JSON.stringify(item.options)}}
Documentation: http://developers.hubspot.com/docs/methods/files/post_files_file_id.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/filemanager/api/v2/files/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/files/delete_files_file_id.
- id
A key field. Template: Id.
- portal_id
Template: Id.
- name
Template: ShortText.
- file
Data type: DT_IMAGE The value is gathered from
{{=item.url}}address.- folder_path
Template: ShortText.
- folder_id
Template: Id.
- archived
Data type: DT_BOOL
- deleted
Data type: DT_BOOL A read-only field.
- version
Data type: DT_I4 A read-only field.
- containing_folder_id
Template: Id. A read-only field.
- size
Data type: DT_I4 A read-only field.
- height
Data type: DT_I4 A read-only field.
- width
Data type: DT_I4 A read-only field.
- encoding
Template: ShortText. A read-only field.
- created
Template: DateTime. A read-only field.
- updated
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- type
Template: ShortText. A read-only field.
- extension
Template: ShortText. A read-only field.
- cloud_key
Template: ShortText. A read-only field.
- rs_url
Template: ShortText. A read-only field.
- rs_uploaded_at
Template: DateTime. A read-only field.
- s3_url
Template: ShortText. A read-only field.
- s3_uploaded_at
Template: DateTime. A read-only field.
- friendly_url
Template: ShortText. A read-only field.
- alt_key
Template: ShortText. A read-only field.
- alt_key_hash
Template: ShortText. A read-only field.
- title
Template: ShortText. A read-only field.
- synced
Data type: DT_BOOL A read-only field.
- meta
A read-only field. Field components:
-
Uses template:
ShortText. - Contains the following components: thumbs, url_scheme.
-
Uses template:
- hidden
Data type: DT_BOOL A read-only field.
- cloud_key_hash
Template: ShortText. A read-only field.
- is_cta_image
Data type: DT_BOOL A read-only field.
- url
Template: ShortText. A read-only field.
- alt_url
Template: ShortText. A read-only field.
- last_used
Template: DateTime. A read-only field.
- options
Field components:
-
Uses template:
ShortText. - Contains the following components: access, ttl, overwrite, duplicateValidationStrategy, duplicateValidationScope.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/filemanager/api/v2/folders.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
deleted_at:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('deleted_at'))}} -
parent_folder_id:
{{=Hubspot.getFolderId(parameters.get('parent_folder_id'))}}
Documentation: http://developers.hubspot.com/docs/methods/files/get_folders.
-
offset:
- [Create] action
-
Endpoint URL address:
/filemanager/api/v2/folders.Documentation: http://developers.hubspot.com/docs/methods/files/post_folders.
- [Update] action
-
Endpoint URL address:
/filemanager/api/v2/folders/{{=item.id}}/move-folder.Documentation: http://developers.hubspot.com/docs/methods/files/post_folders_folder_id_move_folder.
- [Delete] action
-
Endpoint URL address:
/filemanager/api/v2/folders/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/files/delete_folders_folder_id.
- id
A key field. Template: Id.
- portal_id
Template: Id.
- name
Template: ShortText.
- parent_folder_id
Template: Id.
- deleted
Data type: DT_BOOL A read-only field.
- created
Template: DateTime. A read-only field.
- updated
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- full_path
Template: ShortText. A read-only field.
- category
Template: Id. A read-only field.
Based on resource template Content.
- [Read] action
-
Endpoint URL address:
/content/api/v2/layouts.
- portal_id
Template: Id.
- attached_stylesheets
Template: LongText. A composite field.
- body_class
Template: ShortText.
- body_css
Template: ShortText.
- body_css_id
Template: Id.
- category_id
Template: Id.
- custom_head
Template: ShortText.
- enable_domain_stylesheets
Data type: DT_BOOL
- folder
Template: ShortText.
- include_default_custom_css
Template: ShortText.
- is_theme_layout
Data type: DT_BOOL
- label
Template: ShortText.
- last_edit_session_id
Template: Id.
- last_edit_update_id
Template: Id.
- layout_data
Field components:
-
Uses template:
LongText. - Contains the following components: ending_html, root, css_id, section_name, css_style, starting_html, row, rows, is_container, name, css_class, cells, label, cell, css_id_str, params, is_in_container, w, widgets, x, type, html_element.
-
Uses template:
- linked_style_id
Template: Id.
- path
Template: ShortText.
- purchased
Data type: DT_BOOL
- updated_by
Template: ShortText.
Based on resource template Content.
- [Read] action
-
Endpoint URL address:
/content/api/v2/pages.Documentation: http://developers.hubspot.com/docs/methods/pages/get_pages.
- [Create] action
-
Endpoint URL address:
/content/api/v2/pages.Documentation: http://developers.hubspot.com/docs/methods/pages/post_pages.
- [Update] action
-
Endpoint URL address:
/content/api/v2/pages/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/pages/put_pages_page_id.
- [Delete] action
-
Endpoint URL address:
/content/api/v2/pages/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/pages/delete_pages_page_id.
- name
Template: ShortText.
- portal_id
Template: Id.
- campaign
Data type: DT_GUID
- campaign_name
Template: ShortText.
- footer_html
Template: LongText.
- head_html
Template: LongText.
- is_draft
-
Data type: DT_BOOL
Documentation: http://developers.hubspot.com/docs/methods/pages/post_pages_page_id_publish_action.
- meta_description
Template: ShortText.
- meta_keywords
Template: ShortText.
- password
Template: ShortText.
- publish_date
Template: DateTime.
- publish_immediately
Data type: DT_BOOL
- slug
Template: ShortText.
- subcategory
Template: ShortText.
- widget_containers
Data type: DT_NTEXT
- widgets
Data type: DT_NTEXT
- ab_status
Template: ShortText. A read-only field.
- ab_test_id
Template: Id. A read-only field.
- analytics_page_id
Template: Id. A read-only field.
- archived
Data type: DT_BOOL A read-only field.
- attached_stylesheets
Template: LongText. A read-only field. A composite field.
- author_user_id
Template: Id. A read-only field.
- blueprint_type_id
Template: Id. A read-only field.
- cloned_from
Template: ShortText. A read-only field.
- css
Template: ShortText. A read-only field.
- css_text
Template: ShortText. A read-only field.
- current_live_domain
Template: ShortText. A read-only field.
- domain
Template: ShortText. A read-only field.
- enable_domain_stylesheets
Data type: DT_BOOL A read-only field.
- enable_layout_stylesheets=
Data type: DT_BOOL A read-only field.
- featured_image
Template: ShortText. A read-only field.
- flex_areas
Template: LongText. A read-only field.
- folder_id
Template: Id. A read-only field.
- freeze_date
Template: DateTime. A read-only field.
- has_smart_content=False
Data type: DT_BOOL A read-only field.
- has_user_changes
Data type: DT_BOOL A read-only field.
- html_title
Template: ShortText. A read-only field.
- include_default_custom_css
Data type: DT_BOOL A read-only field.
- keywords
Template: LongText. A read-only field.
- last_edit_session_id
Template: Id. A read-only field.
- last_edit_update_id
Template: Id. A read-only field.
- legacy_blog_tabid
Template: Id. A read-only field.
- page_expiry_date
Data type: DT_BOOL A read-only field.
- page_expiry_enabled
Data type: DT_BOOL A read-only field.
- page_expiry_redirect_id
Template: Id. A read-only field.
- page_expiry_redirect_url
Template: ShortText. A read-only field.
- page_redirected
Template: ShortText. A read-only field.
- performable_url
Template: ShortText. A read-only field.
- personas
Template: LongText. A read-only field.
- published_url
Template: ShortText. A read-only field.
- rss_email_by_text
Template: ShortText. A read-only field.
- rss_email_click_through_text
Template: ShortText. A read-only field.
- rss_email_comment_text
Template: ShortText. A read-only field.
- rss_email_image_max_width
Data type: DT_I4 A read-only field.
- scheduled_update_date
Template: DateTime. A read-only field.
- staged_from
Template: ShortText. A read-only field.
- style_override_id
Template: Id. A read-only field.
- template_path
Template: ShortText. A read-only field.
- tms_id
Template: Id. A read-only field.
- unpublished_at
Template: DateTime. A read-only field.
- url
Template: ShortText. A read-only field.
- widgetcontainers
Template: LongText. A read-only field. A composite field.
Based on resource template Content.
- [Read] action
-
Endpoint URL address:
/content/api/v2/templates.Documentation: http://developers.hubspot.com/docs/methods/templates/get_templates.
- [Create] action
-
Endpoint URL address:
/content/api/v2/templates.Documentation: http://developers.hubspot.com/docs/methods/templates/post_templates.
- [Update] action
-
Endpoint URL address:
/content/api/v2/templates/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/templates/put_templates_template_id.
- [Delete] action
-
Endpoint URL address:
/content/api/v2/templates/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/templates/delete_templates_template_id.
- portal_id
Template: Id.
- category_id
Template: Id.
- folder
Template: ShortText.
- template_type
Data type: DT_I4
- path
Template: ShortText.
- source
Data type: DT_NTEXT
- attached_stylesheets
Template: LongText. A read-only field. A composite field.
- cdn_minified_url
Template: ShortText. A read-only field.
- cdn_url
Template: ShortText. A read-only field.
- enable_domain_stylesheets
Data type: DT_BOOL A read-only field.
- generated_from_layout_id
Template: Id. A read-only field.
- include_default_custom_css
Template: ShortText. A read-only field.
- is_available_for_new_content
Data type: DT_BOOL A read-only field.
- is_deletable
Data type: DT_BOOL A read-only field.
- is_from_layout
Data type: DT_BOOL A read-only field.
- is_read_only
Data type: DT_BOOL A read-only field.
- is_renameable
Data type: DT_BOOL A read-only field.
- is_theme_layout
Data type: DT_BOOL A read-only field.
- label
Template: ShortText. A read-only field.
- last_edit_session_id
Template: Id. A read-only field.
- last_edit_update_id
Template: Id. A read-only field.
- linked_style_id
Template: Id. A read-only field.
- migrated_from_style_manager
Data type: DT_BOOL A read-only field.
- thumbnail_path
Template: ShortText. A read-only field.
- thumbnail_width
Data type: DT_I4 A read-only field.
- type
Template: ShortText. A read-only field.
- updated_by
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/url-mappings/v3/url-mappings.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
created:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('created'))}} -
deletedAt:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('deletedAt'))}} -
updated:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('updated'))}}
Documentation: http://developers.hubspot.com/docs/methods/url-mappings/get_url_mappings.
-
offset:
- [Create] action
-
Endpoint URL address:
/url-mappings/v3/url-mappings.Documentation: http://developers.hubspot.com/docs/methods/url-mappings/post_url_mappings.
- [Update] action
-
Endpoint URL address:
/url-mappings/v3/url-mappings/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/url-mappings/put_url_mappings_url_mapping_id.
- [Delete] action
-
Endpoint URL address:
/url-mappings/v3/url-mappings/{{=item.id}}.Documentation: http://developers.hubspot.com/docs/methods/url-mappings/delete_url_mappings_url_mapping_id.
- id
A key field. Template: Id.
- name
Template: ShortText.
- portalId
Template: Id.
- routePrefix
Template: ShortText.
- destination
Template: ShortText.
- redirectStyle
Data type: DT_I4
- isMatchFullUrl
Data type: DT_BOOL
- isMatchQueryString
Data type: DT_BOOL
- isOnlyAfterNotFound
Data type: DT_BOOL
- isPattern
Data type: DT_BOOL
- precedence
Data type: DT_I4
- isProtocolAgnostic
Data type: DT_BOOL A read-only field.
- isRegex
Data type: DT_BOOL A read-only field.
- isTrailingSlashOptional
Data type: DT_BOOL A read-only field.
- contentGroupId
Template: Id. A read-only field.
- created
Template: DateTime. A read-only field.
- updated
Template: DateTime. A read-only field.
- deletedAt
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/keywords/v1/keywords.
The result is extracted from:{{=response.keywords}}.Documentation: http://developers.hubspot.com/docs/methods/keywords/get_keywords.
- [Create] action
-
Endpoint URL address:
/keywords/v1/keywords.Documentation: http://developers.hubspot.com/docs/methods/keywords/create_keyword.
- [Delete] action
-
Endpoint URL address:
/keywords/v1/keywords/{{=item.keyword_guid}}.Documentation: http://developers.hubspot.com/docs/methods/keywords/delete_keyword.
- keyword_guid
A key field. Data type: DT_GUID
- keyword
Template: ShortText.
- campaigns
Template: LongText. A read-only field.
- created_at
Template: DateTime. A read-only field.
- leads
Data type: DT_I4 A read-only field.
- visits
Data type: DT_I4 A read-only field.
- contacts
Data type: DT_I4 A read-only field.
- country
Data type: DT_I4 A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/broadcast/v1/channels/setting/publish/current.
- channelId
A key field. Template: Id.
- portalId
Template: Id.
- channelGuid
Data type: DT_GUID
- channelKey
Template: ShortText.
- createdAt
Template: DateTime.
- updatedAt
Template: DateTime.
- accountGuid
Data type: DT_GUID
- accountSlug
Template: ShortText.
- accountType
Template: ShortText.
- active
Data type: DT_BOOL
- autoPublish
Data type: DT_BOOL
- avatarUrl
Template: ShortText.
- channelSlug
Template: ShortText.
- dataMap
Field components:
-
Uses template:
ShortText. - Contains the following components: imageUrl, realName, userId, userName.
-
Uses template:
- displayName
Template: ShortText.
- followMe
Data type: DT_BOOL
- hidden
Data type: DT_BOOL
- monitoring
Data type: DT_BOOL
- name
Template: ShortText.
- profileUrl
Template: ShortText.
- reach
Data type: DT_BOOL
- reachType
Template: ShortText.
- settings
Field components:
- Contains the following components: autoPublish, followMe, hidden, monitoring, publish, reach.
- shared
Data type: DT_BOOL
- twitterId
Template: Id.
- twitterScreenName
Template: ShortText.
- type
Template: ShortText.
- username
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/broadcast/v1/broadcasts.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
count:
{{=parameters.batchSize}}
Documentation: http://developers.hubspot.com/docs/methods/social_media/get_broadcasts.
-
offset:
- [Create] action
-
Endpoint URL address:
/broadcast/v1/broadcasts.Documentation: http://developers.hubspot.com/docs/methods/social_media/create_broadcast.
- [Delete] action
-
Endpoint URL address:
/broadcast/v1/broadcasts/{{=item.broadcastGuid}}.Documentation: http://developers.hubspot.com/docs/methods/social_media/cancel_broadcast.
- broadcastGuid
A key field. Template: Id.
- portalId
Template: Id.
- channelGuid
Data type: DT_GUID
- triggerAt
Template: DateTime.
- content
Field components:
-
Uses template:
ShortText. - Contains the following components: body, linkPreviewSuppressed, originalBody, postTitle, uncompressedLinks.
-
Uses template:
- campaignGuid
Data type: DT_GUID
- campaignName
Template: ShortText.
- channel
Template: ShortText.
- channelKey
Template: ShortText.
- clientTag
Template: ShortText.
- foreignId
Template: ShortText.
- isFailed
Data type: DT_BOOL
- isPending
Data type: DT_BOOL
- isPublished
Data type: DT_BOOL
- isRetry
Data type: DT_BOOL
- linkGuid
Template: ShortText.
- message
Template: LongText.
- messageUrl
Template: ShortText.
- remoteContentId
Template: Id.
- remoteContentType
Template: ShortText.
- taskQueueId
Template: ShortText.
- wasDraft
Data type: DT_BOOL
- createdAt
Template: DateTime. A read-only field.
- clicks
Data type: DT_I4 A read-only field.
- createdBy
Template: Id. A read-only field.
- finishedAt
Template: DateTime. A read-only field.
- interactionCounts
Template: LongText. A read-only field.
- interactions
Template: LongText. A read-only field.
- interactionsCount
Data type: DT_I4 A read-only field.
- likes
Data type: DT_I4 A read-only field.
- replies
Data type: DT_I4 A read-only field.
- retweets
Data type: DT_I4 A read-only field.
- updatedBy
Template: Id. A read-only field.
- linkTaskQueueId
Template: Id. A read-only field.
- groupGuid
Data type: DT_GUID A read-only field.
- status
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/analytics/v2/reports/{{=parameters.category}}/total.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- category: Required. The category used to break down the analytics data.
The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
- [Read summarize] action
-
Endpoint URL address:
/analytics/v2/reports/{{=parameters.category}}/{{=parameters.time_period}}.
The result is extracted from:{{=[{ breakdowns: function() { var result = []; _.each(response, function(v, k) { _.each(v, function(item) { result.push(_.extend({ period: k }, item)); }); }); return result; }() }]}}.The action has the following user-defined parameters:
- category: Required. The category used to break down the analytics data.
- time_period: Required. The time period used to group the data
The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
f:
{{=parameters.get('f') && parameters.f.split(',')}} -
e:
{{=parameters.get('e') && parameters.e.split(',')}}
- totals
Template: Analytics.
- breakdowns
Field components:
- An array.
-
Uses template:
Analytics. - Contains the following components: breakdown, period, meta.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/analytics/v2/reports/sessions/total.
The result is extracted from:{{=response.breakdowns}}.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
-
offset:
- [Read summarize] action
-
Endpoint URL address:
/analytics/v2/reports/sessions/{{=parameters.time_period}}.
The result is extracted from:{{=function() { var result = []; _.each(response, function(v, k) { _.each(v, function(item) { return result.push(_.extend({ period: k }, item)); }); }); return result; }()}}.The action has the following user-defined parameters:
- time_period: Required. The time period used to group the data.
The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}}
- breakdown
Template: ShortText.
- period
Template: ShortText.
- directTraffic
Data type: DT_I4
- desktop
Data type: DT_I4
- referrals
Data type: DT_I4
- mobile
Data type: DT_I4
- organicSearch
Data type: DT_I4
- paidSearch
Data type: DT_I4
- others
Data type: DT_I4
- otherCampaigns
Data type: DT_I4
- emailMarketing
Data type: DT_I4
- paidSocial
Data type: DT_I4
- socialMedia
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/crm-objects/v1/objects/tickets/paged.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
properties:
{{=parameters.fields}}
Documentation: https://developers.hubspot.com/docs/methods/tickets/get-all-tickets.
-
offset:
- [Create] action
-
Endpoint URL address:
/crm-objects/v1/objects/tickets.Documentation: https://developers.hubspot.com/docs/methods/tickets/create-ticket.
- [Update] action
-
Endpoint URL address:
/crm-objects/v1/objects/tickets/{{=item.objectId}}.
The action uses PUT method.Documentation: https://developers.hubspot.com/docs/methods/tickets/update-ticket.
- [Delete] action
-
Endpoint URL address:
/crm-objects/v1/objects/tickets/{{=item.objectId}}.Documentation: https://developers.hubspot.com/docs/methods/tickets/delete-ticket.
- objectId
A key field. Template: Id.
- objectType
Template: ShortText. A read-only field.
- portalId
Template: Id. A read-only field.
- version
Data type: DT_I4 A read-only field.
- isDeleted
Data type: DT_BOOL A read-only field.
- [External]
-
The external fields URL address:
/properties/v2/tickets/properties.Before setting, the value is processed with
{{=Hubspot.convertToHS(field.fieldType, value)}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/crm-objects/v1/objects/products/paged.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
properties:
{{=parameters.fields}}
Documentation: https://developers.hubspot.com/docs/methods/products/get-all-products.
-
offset:
- [Create] action
-
Endpoint URL address:
/crm-objects/v1/objects/products.Documentation: https://developers.hubspot.com/docs/methods/products/create-product.
- [Update] action
-
Endpoint URL address:
/crm-objects/v1/objects/products/{{=item.objectId}}.
The action uses PUT method.Documentation: https://developers.hubspot.com/docs/methods/products/update-products.
- [Delete] action
-
Endpoint URL address:
/crm-objects/v1/objects/products/{{=item.objectId}}.Documentation: https://developers.hubspot.com/docs/methods/products/delete-product.
- objectId
A key field. Template: Id.
- objectType
Template: ShortText. A read-only field.
- portalId
Template: Id. A read-only field.
- version
Data type: DT_I4 A read-only field.
- isDeleted
Data type: DT_BOOL A read-only field.
- [External]
-
The external fields URL address:
/properties/v2/products/properties.Before setting, the value is processed with
{{=Hubspot.convertToHS(field.fieldType, value)}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/crm-objects/v1/objects/line_items/paged.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
properties:
{{=parameters.fields}}
Documentation: https://developers.hubspot.com/docs/methods/line-items/get-all-line-items.
-
offset:
- [Create] action
-
Endpoint URL address:
/crm-objects/v1/objects/line_items.Documentation: https://developers.hubspot.com/docs/methods/line-items/create-line-item.
- [Update] action
-
Endpoint URL address:
/crm-objects/v1/objects/line_items/{{=item.objectId}}.
The action uses PUT method.Documentation: https://developers.hubspot.com/docs/methods/line-items/update-line-item.
- [Delete] action
-
Endpoint URL address:
/crm-objects/v1/objects/line_items/{{=item.objectId}}.Documentation: https://developers.hubspot.com/docs/methods/line-items/delete-line-item.
- objectId
A key field. Template: Id.
- objectType
Template: ShortText. A read-only field.
- portalId
Template: Id. A read-only field.
- version
Data type: DT_I4 A read-only field.
- isDeleted
Data type: DT_BOOL A read-only field.
- [External]
-
The external fields URL address:
/properties/v2/line_items/properties.Before setting, the value is processed with
{{=Hubspot.convertToHS(field.fieldType, value)}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/properties/v2/{{=parameters.object_type}}/properties.
The result is extracted from:{{=response}}.The action has the following user-defined parameters:
- object_type: Required. The specific object that you want the properties for.
Documentation: https://developers.hubspot.com/docs/methods/crm-properties/get-properties.
- [Create] action
-
Endpoint URL address:
/properties/v2/{{=parameters.object_type}}/properties.The action has the following user-defined parameters:
- object_type: Required. The specific object that you want to create a new property for.
Documentation: https://developers.hubspot.com/docs/methods/crm-properties/create-property.
- [Update] action
-
Endpoint URL address:
/properties/v2/{{=parameters.object_type}}/properties/named/{{=item.name}}.The action has the following user-defined parameters:
- object_type: Required. The specific object that you want to update the property for.
Documentation: https://developers.hubspot.com/docs/methods/crm-properties/update-property.
- [Delete] action
-
Endpoint URL address:
/properties/v2/{{=parameters.object_type}}/properties/named/{{=item.name}}.The action has the following user-defined parameters:
- object_type: Required. The specific object type that you want delete the property for.
Documentation: https://developers.hubspot.com/docs/methods/crm-properties/delete-property.
- name
A key field. Template: ShortText.
- label
Template: ShortText.
- description
Template: LongText.
- groupName
Template: ShortText.
- type
Template: ShortText.
- fieldType
Template: ShortText.
- hidden
Template: ShortText.
- options
Template: LongText. A composite field.
- calculated
Data type: DT_BOOL
- externalOptions
Data type: DT_BOOL
- isCustomizedDefault
Data type: DT_BOOL
- deleted
Data type: DT_BOOL A read-only field.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- displayOrder
Data type: DT_I4
- readOnlyValue
Data type: DT_BOOL
- readOnlyDefinition
Data type: DT_BOOL
- mutableDefinitionNotDeletable
Data type: DT_BOOL
- favorited
Data type: DT_BOOL
- favoritedOrder
Data type: DT_I4
- displayMode
Template: ShortText.
- showCurrencySymbol
Template: ShortText.
- createdUserId
Template: ShortText. A read-only field.
- textDisplayHint
Template: ShortText.
- numberDisplayHint
Template: ShortText.
- optionsAreMutable
Data type: DT_BOOL
- referencedObjectType
Template: ShortText.
- formField
Data type: DT_BOOL
- hubspotDefined
Data type: DT_BOOL
- updatedUserId
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/crm/v3/objects/{{=parameters.object_type}}.
The result is extracted from:{{=response.results}}.
The result is paginated.The action has the following user-defined parameters:
- object_type: Required. Specify object type.
The following request parameters will be automatically processed:
-
after:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
properties:
{{=parameters.fields.join(',')}}
- [Read search] action
-
Endpoint URL address:
/crm/v3/objects/{{=parameters.object_type}}/search.
The result is extracted from:{{=response.results}}.
The action uses POST method.
The result is paginated.The action has the following user-defined parameters:
- object_type: Required. Specify object type.
- filters: Optional. Specify in JSON format (e.g). [{"propertyName": "updatedAt", "values": ["string"], "operator": "GT"}]
The following request parameters will be automatically processed:
-
application/json:
{{={ limit: parameters.batchSize, after: parameters.iterator, properties: _.toArray(parameters.fields), filterGroups: parameters.get('filters') && [{ filters: JSON.parse(parameters.filters) }] } }}
- [Create] action
-
Endpoint URL address:
/crm/v3/objects/{{=parameters.object_type}}.The action has the following user-defined parameters:
- object_type: Required. Specify object type.
- [Update] action
-
Endpoint URL address:
/crm/v3/objects/{{=parameters.object_type}}/{{=item[resource.keyField]}}.
The action uses PATCH method.The action has the following user-defined parameters:
- object_type: Required. Specify object type.
- [Delete] action
-
Endpoint URL address:
/crm/v3/objects/{{=parameters.object_type}}/{{=item[resource.keyField]}}.The action has the following user-defined parameters:
- object_type: Required. Specify object type.
- id
A key field. Template: Id.
- archived
Data type: DT_BOOL A read-only field.
- createdAt
Data type: DT_DBTIMESTAMP A read-only field.
- updatedAt
Data type: DT_DBTIMESTAMP A read-only field.
- [External]
-
The external fields URL address:
/properties/v2/{{=parameters.object_type}}/properties.- {{=external.name}}
Data type: {{=Hubspot.getDataType(external.type)}} ( length {{=250}} ) The gathered value is processed with
{{=item.properties[field.name]}}expression. Before setting, the value is processed with{{=value}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/crm/v3/objects/{{=parameters.fromObjectType}}/{{=parameters.fromObjectId}}/associations/{{=parameters.toObjectType}}.
The result is extracted from:{{=_.map(response.results, function(item) { return { toObjectId: item.id, type: item.type }; })}}.
The result is paginated.The action has the following user-defined parameters:
- fromObjectType: Required. Specify From object type.
- fromObjectId: Required. Specify From object identifier.
- toObjectType: Required. Specify To object type.
The following request parameters will be automatically processed:
-
after:
{{=parameters.iterator}}
- [Create] action
-
Endpoint URL address:
/crm/v3/objects/{{=item.fromObjectType}}/{{=item.fromObjectId}}/associations/{{=item.toObjectType}}/{{=item.toObjectId}}/{{=item.type}}.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{={ inputs: [{ from: { id: item.fromObjectId }, to: { id: item.toObjectId }, type: item.type }] } }}
-
application/json:
- [Delete] action
-
Endpoint URL address:
/crm/v3/objects/{{=item.fromObjectType}}/{{=item.fromObjectId}}/associations/{{=item.toObjectType}}/{{=item.toObjectId}}/{{=item.type}}.
- fromObjectType
Template: ShortText.
- fromObjectId
Template: Id.
- toObjectType
Template: ShortText.
- toObjectId
Template: Id.
- type
Template: ShortText.
Based on resource template Content.
- [Read] action
-
Endpoint URL address:
/marketing/v3/emails/.
The result is extracted from:{{=response.results}}.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=undefined}} -
after:
{{=parameters.iterator}} -
properties:
{{=parameters.fields}} -
createdAt:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('createdAt'))}} -
createdAfter:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('createdAfter'))}} -
createdBefore:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('createdBefore'))}} -
updatedAt:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('updatedAt'))}} -
updatedAfter:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('updatedAfter'))}} -
updatedBefore:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('updatedBefore'))}}
Documentation: https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#get-%2Fmarketing%2Fv3%2Femails%2F.
-
offset:
- [Read single] action
-
Endpoint URL address:
/marketing/v3/emails/{{=parameters.id}}/draft.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- id: Required. Specify email identifier.
Documentation: https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#get-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D%2Fdraft.
- [Read revision] action
-
Endpoint URL address:
/marketing/v3/emails/{{=parameters.id}}/revisions.
The result is extracted from:{{=response.results}}.The action has the following user-defined parameters:
- id: Required. Specify email identifier.
The following request parameters will be automatically processed:
-
offset:
{{=undefined}} -
after:
{{=parameters.iterator}}
Documentation: https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#get-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D%2Frevisions.
- [Create] action
-
Endpoint URL address:
/marketing/v3/emails/.Documentation: https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#post-%2Fmarketing%2Fv3%2Femails%2F.
- [Update] action
-
Endpoint URL address:
/marketing/v3/emails/{{=item.id}}.
The action uses PATCH method.Documentation: https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#patch-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D.
- [Delete] action
-
Endpoint URL address:
/marketing/v3/emails/{{=item.id}}.Documentation: https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#delete-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D.
- id
A key field. Template: Id.
- archived
Data type: DT_BOOL A read-only field.
- activeDomain
Template: ShortText.
- businessUnitId
Template: Id.
- campaign
Template: ShortText.
- campaignName
Template: ShortText.
- createdAt
Template: IsoDateTime. A read-only field.
- createdById
Template: Id. A read-only field.
- content
Field components:
-
Uses template:
MarketingEmailContentProp. - Contains the following components: smartFields, themeSettingsValues, flexAreas, widgets, plainTextVersion, templatePath, widgetContainers, styleSettings.
-
Uses template:
- deletedAt
Template: IsoDateTime. A read-only field.
- feedbackSurveyId
Template: ShortText.
- folderId
Template: Id.
- from
Field components:
-
Uses template:
ShortText. - Contains the following components: customReplyTo, fromName, replyTo.
-
Uses template:
- isPublished
Data type: DT_BOOL A read-only field.
- isTransactional
Data type: DT_BOOL A read-only field.
- jitterSendTime
Data type: DT_BOOL
- location
Template: ShortText.
- name
Template: ShortText.
- publishDate
Template: IsoDateTime.
- publishedAt
Template: IsoDateTime. A read-only field.
- publishedById
Template: Id. A read-only field.
- rssData
Field components:
-
Uses template:
ShortText. - Contains the following components: blogImageMaxWidth, blogEmailType, hubspotBlogId, rssEntryTemplate, timing, maxEntries, useHeadlineAsSubject, blogLayout, url.
-
Uses template:
- sendOnPublish
Data type: DT_BOOL
- state
Template: ShortText.
- stats
Template: Stat. A read-only field.
- subcategory
Template: ShortText.
- subject
Template: ShortText.
- subscriptionDetails
Field components:
-
Uses template:
Id. - Contains the following components: officeLocationId, preferencesGroupId, subscriptionId.
-
Uses template:
- testing
Field components:
-
Uses template:
ShortText. - Contains the following components: abSamplingDefault, abSampleSizeDefault, abStatus, abTestPercentage, hoursToWait, testId, abSuccessMetric.
-
Uses template:
- type
Template: ShortText.
- to
Field components:
-
Uses template:
MarketingEmailTo. - Contains the following components: contactIlsLists, limitSendFrequency, suppressGraymail, contactIds, contactLists.
-
Uses template:
- updatedAt
Template: IsoDateTime. A read-only field.
- updatedById
Template: Id. A read-only field.
- webversion
Field components:
-
Uses template:
ShortText. - Contains the following components: domain, redirectToPageId, isPageRedirected, redirectToUrl, title, metaDescription, pageExpiryEnabled, slug, url, expiresAt.
-
Uses template:
- workflowNames
Template: LongText. A composite field.
- [Read] action
-
Endpoint URL address:
/crm-pipelines/v1/pipelines/{{=parameters.object_type}}.
The result is extracted from:{{=response.results}}.The action has the following user-defined parameters:
- object_type: Required. Select object type.
Documentation: https://legacydocs.hubspot.com/docs/methods/pipelines/get_pipelines_for_object_type.
- pipelineId
A key field. Template: Id.
- createdAt
Template: DateTime. A read-only field.
- updatedAt
Template: DateTime. A read-only field.
- objectType
Template: ShortText.
- label
Template: ShortText.
- displayOrder
Data type: DT_I4
- active
Data type: DT_BOOL
- stages
Field components:
- An array.
- Contains the following components: stageId, createdAt, updatedAt, objectType, label, displayOrder, metadata, active.
- default
Data type: DT_BOOL
- [Read] action
-
The result is extracted from:{{=response.objects}}.
The result is paginated.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
_includeUserParameters:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Update] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Upsert] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
- [External]
-
- {{=external.name}}
Data type: {{=Hubspot.getDataType(external.type)}} ( length {{=250}} ) The gathered value is processed with
{{=Hubspot.convertToJS(field.fieldType, (item.properties[field.name] || {}).value)}}expression.
Based on resource template Base.
- [Read] action
-
The result is extracted from:.
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
startDate:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('startDate'))}} -
endDate:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('endDate'))}}
-
offset:
- id
A key field. Template: Id.
- portalId
Template: Id.
- name
Template: ShortText.
- description
Template: ShortText.
- ownerId
Template: Id.
- eventDate
Template: DateTime.
- eventType
Template: ShortText.
- category
Template: ShortText.
- state
Template: ShortText.
- campaignGuid
Data type: DT_GUID
- topicIds
Template: ShortText. A composite field.
- contentGroupId
Template: Id.
- categoryId
Template: Id. A read-only field.
- contentId
Template: Id. A read-only field.
- url
Template: ShortText. A read-only field.
- createdById
Template: Id. A read-only field.
- createdBy
Data type: DT_I8 A read-only field.
- previewKey
Template: ShortText. A read-only field.
- socialUsername
Template: ShortText. A read-only field.
- socialDisplayName
Template: ShortText. A read-only field.
- avatarUrl
Template: ShortText. A read-only field.
- recurring
Data type: DT_BOOL A read-only field.
Based on resource template Base.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
created:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('created'))}} -
deleted_at:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('deleted_at'))}} -
publish_date:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('publish_date'))}} -
updated:
{{=Hubspot.convertToHS(DataType.DT_DBTIMESTAMP, parameters.get('updated'))}}
-
offset:
- id
A key field. Template: Id.
- created
Template: DateTime. A read-only field.
- updated
Template: DateTime. A read-only field.
- deleted_at
Template: DateTime. A read-only field.
- DateTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=Hubspot.convertToJS(field.fieldType, value)}}expression. Before setting, the value is processed with{{=Hubspot.convertToHS(field.fieldType, value)}}expression.- ShortText
Data type: DT_WSTR ( length 250 )
- LongText
Data type: DT_WSTR ( length 1000 )
- IsoDateTime
Data type: DT_DBTIMESTAMP
- Id
Data type: DT_UI8
- option
Field components:
-
Uses template:
ShortText. - Contains the following components: label, value, displayOrder, doubleData, hidden, description, readOnly.
-
Uses template:
- Analytics
Field components:
- Contains the following components: rawViews, visits, visitors, leads, contacts, subscribers, marketingQualifiedLeads, salesQualifiedLeads, opportunities, customers, pageviewsPerSession, bounceRate, timePerSession, newVisitorSessionRate, sessionToContactRate, contactToCustomerRate, ctaViews, entrances, exits, timePerPageview, pageBounceRate, exitsPerPageview, submissions, formViews, standardViews, contactsPerPageview, customersPerPageview, submissionsPerPageview, leadsPerView, submissionsPerFormView, pageviewsMinusExits, time, bounces, visibles, interactions, pageTime, pageBounces.
- MarketingEmailStatProp
Field components:
- Contains the following components: additionalProp1, additionalProp2, additionalProp3.
- MarketingEmailContentProp
Field components:
-
Uses template:
LongText. - Contains the following components: additionalProp1, additionalProp2, additionalProp3.
-
Uses template:
- MarketingEmailTo
Field components:
-
Uses template:
LongText. - Contains the following components: include, exclude.
-
Uses template:
- MarketingEmailStat
Field components:
-
Uses template:
MarketingEmailStatProp. - Contains the following components: additionalProp1, additionalProp2, additionalProp3.
-
Uses template:
- MarketingEmailFont
Field components:
-
Uses template:
ShortText. - Contains the following components: size, color, underline, bold, italic, font.
-
Uses template:
- EmailContentBody
Field components:
-
Uses template:
LongText. - Contains the following components: child_css, css, id, label, name, type.
-
Uses template:
- DeviceType
Field components:
- Contains the following components: computer, mobile, unknown.
- Stat
Field components:
-
Uses template:
MarketingEmailStat. - Contains the following components: deviceBreakdown, qualifierStats, counters, ratios.
-
Uses template:
Knowledge Base
- Where can I find the documentation for the HubSpot Connection?
- How to add contacts to contact list in Hubspot.
- Error Message: Couldn't complete the connection. An invalid scoped name was provided. Contact the app developer
What's New
- New: Updated to use new v3 Marketing Email API.
- New: Updated to use new v3 Owners API.
- New: Included 'Form Submission' resource.
- Fixed: Failed to upload a file using 'File Transfer Task' (Thank you, Kim).
- New: Support for custom objects.
- New: Support for 'Marketing Email' resource.
- Fixed: Various fixes and enhancements.
- Fixed: Infinite loop when trying to retrieve data from 'Contact' resource (Thank you, Geoff).
- New: Support for 'Analytics', 'Association', 'Ticket', 'Product', 'Line Item', 'CRM Object Property' resources.
- Fixed: Various fixes and enhancements.
- Fixed: Failed to read data from 'Email Campaign' resource (Thank you, Freddie).
- New: Support for OAuth 2.0 authentication.
- New: Support for add/remove of contacts in list.
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.