General
HubSpot on the APIcenter platform has been developed to be as efficient as possible and will use batch requests where it can to retrieve data. However, to prevent problems when a particular item crashes during processing, leaving unassociated items, any associations are created directly after the item has been processed.
For example, when a customer has been created it will be associated with the company straight away instead of processing any other contacts first before doing so. This will prevent the association to be missing when processing the next contact may crash the flow for whatever reason.
Ordertypes
Orders are supported. More information about different order types can be found here.
Important settings
- Amount to process
The amount of orders we try to sync at once. Always check if the target system can handle the amount of data.
- Specify the Date from which you want to retrieve Orders
Determines the date from which orders are retrieved based on the modified date.
- Pipeline name to set
This setting is used to see if it is a valid pipeline by doing a request to retrieve the pipelines and will try to find the given pipeline in the results by looking for any pipeline that has either the name or label that matches the setting value. If it can’t be found the flow will abort and throw an exception.
- Deal stage name to set
a method or property used to update the deal stage of a deal (also known as an opportunity) in HubSpot's CRM system.
Datamapper
Per default APIcenter supplies a mapping that makes sure you can send order data towards the target application. You can also make adjustments to this yourself.
Default fields that are mapped are for example:
- Customer Name
- Billing address street
- Number
- Postalcode
- City
- Country
- Shipping address street
- Number
- Postalcode
- City
- Country
- SKU/EAN
- Quantity
- Price
More information about data mapping can be found here.
Settings used
There are several settings that can be set or are required to be able to send deals to HubSpot.
| Setting | TYPE | Category | Function/Effect |
|---|---|---|---|
| create_contacts_only | FLOW | Customer Settings | Enable or disable that only contacts will be created and the company will be skipped or not |
| update_existing_contacts | Integration | Customer Settings | Enable or disable updating existing contacts |
| update_existing_contact_name | Integration | Customer Settings | Enable or disable updating existing contact names |
| update_existing_accounts | Integration | Customer Settings | Enable or disable updating existing companies |
| update_existing_account_name | Integration | Customer Settings | Enable or disable updating existing companies names |
| use_as_customer_email | Flow | Customer Settings | Can be used to specify the name of the field holding the email address of the company. (default: company_email) |
Endpoints used
| Endpoint | Method | Definition |
|---|---|---|
| getProperties | POST | /v3/objects/properties/{object} |
| createDeals | POST | /v3/objects/deals |
| sendOrderLine | POST | /v3/objects/line_items |
| associate | POST | /v3/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}/{associationTypeId} |
| getAssociationTypes | GET | /v3/associations/{objectType}/{toObjectType}/types |
| getAssociations | GET | /v4/objects/{objectType}/{objectId}/associations/{toObjectType} |
| getCompanyBatch | POST | /v3/objects/companies/batch/read |
| getContactBatch | POST | /v3/objects/contacts/batch/read |
| checkOrderExists | GET | /v3/objects/deals/search |
| checkCustomerExists | POST | /v3/objects/contacts/search |
| checkCompanyExists | POST | /v3/objects/companies/search |
| checkProductExists | POST | /v3/objects/products/search |
| createProduct | POST | /v3/objects/products |
| getPipelines | GET | /v3/pipelines/deals/ |
| createCustomer | POST | /v3/objects/contacts |
| updateCustomer | PATCH | /v3/objects/contacts/{id} |
| createCompany | POST | /v3/objects/companies |
| updateCompany | PATCH | /v3/objects/companies/{id} |
| sendCustomer | POST | /v3/objects/contacts |
| updateContact | PATCH | /v3/objects/contacts/{id} |
| createContact | POST | /v3/objects/contacts |