Hubspot Component is designed to connect to the Hubspot API.
Name | Mandatory | Description | Values |
---|---|---|---|
REQUEST_MAX_RETRY |
false | Specifies how many times the system retries a failed API request (default: 3) | any integer above 0 |
RENEW_LIMIT |
false | Maximum number of records retrieved by the Get New and Updated Objects trigger before advancing the start date (default: 9800) |
any integer above 0 and less 10000 |
HubSpot component authentication occurs via OAuth 2.0. Before you can make it work on our platform you MUST create an OAuth2 App on HubSpot side.
The HubSpot documentation already contains a detailed explanation of the process and we encourage you to follow it.
Please Note: After granting access, you should be redirected back to our platform via a
redirect_url
. To do this, you will need to provide our OAuth Callback Redirect URL.
1. During the OAuth2 App creation you would need to select an existing Auth Client from the drop-down list Choose Auth Client or create the new one. Next you MUST specify the following fields:
Field name | Mandatory | Description |
---|---|---|
Name | true | A name for your Auth Client (can be any value) |
Client ID | true | OAuth Client ID (provided by HubSpot) |
Client Secret | true | OAuth Client Secret (provided by HubSpot) |
Authorization Endpoint | true | OAuth authorization endpoint. ex: https://app-eu1.hubspot.com/oauth/authorize |
Token Endpoint | true | OAuth Token endpoint for refreshing the access token: https://api.hubapi.com/oauth/v1/token |
2. Fill-in the field Name Your Credential (any).
3. Fill-in the field Scopes like:
crm.objects.contacts.read crm.objects.contacts.write crm.schemas.contacts.read oauth
Please Note:
- Scopes must be the same as provided during app creation in Hubspot, use a space-separated list (not comma-separated).
- The scope
oauth
is always required for verification and must be included in the scopes list for all app installs.- The required scopes for your integration depend on the types of HubSpot objects your flow will access. You must ensure that all scopes necessary to access the specific object types you want to retrieve or modify are included in this list.
- Required scopes must always be included in the OAuth
scope
parameter for your app to work correctly.- Conditionally required scopes depend on which HubSpot objects or features your app accesses. For instance, if your flow retrieves contacts, you must include contact-related scopes like
crm.objects.contacts.read
.
4. Click on Authenticate button - if you have not logged into HubSpot before, then log in by entering data in the login window that appears
5. Click on Verify button for verifying your credentials
6. Click on Save button for saving your credentials.
Warning: To maintain a smooth experience, we recommend reusing stored credentials where possible. Duplicating secrets across OAuth clients can result in errors and complications.
The user who authorizes the component (i.e., logs in during the OAuth flow) must have the necessary HubSpot user permissions to access the HubSpot objects your flow will handle.
To verify and manage user permissions, users can refer to the official HubSpot guide on user permissions and roles.
If the authorizing user lacks permissions for certain objects, your flow may fail or return authorization errors.
Retrieves new or modified objects in HubSpot based on a polling mechanism.
Max Amount of Polling Pages
is set.None
Fetch page
: An object with a results key containing an array of records.Emit Individually
: Each object fills the entire message.After retrieving 9800 records, the connector will take the highest value of the selected Field to Poll from the last polling page and use it as the Start Time
for the next polling cycle.
Records with exactly that timestamp will be excluded from the current iteration and included in the next one to avoid duplicates and ensure no records are missed.
This trigger is deprecated. Please use HubSpot Webhook component instead.
Receive data from HubSpot based on configured webhooks.
Client secret - Provide Client secret from HubSpot application here otherwise you will get an error during the webhook requests in case of incorrect or missing value.
Triggered object from HubSpot.
Executes custom request.
false
.GET
, POST
, PUT
, PATCH
, DELETE
, required. HTTP verb to use in the request.Performs an upsert (update or create) operation on an object in HubSpot.
Please Note: “Email” is valid only for the Contacts object type.
Metadata is generated dynamically based on the selected object type and fields.
For each custom file field, an input object is generated to upload a file for that field. The object includes the following fields:
Files are uploaded using the Hubspot Files API.
Looks up a set of objects in HubSpot using a unique field. All specified items must be found, otherwise, an error will be thrown.
Please Note: “Email” is valid only for the Contacts object type.
file
.An array of ID values to look up.
Returns the matched objects.
Retrieves a single object from HubSpot using a unique field.
file
.ID value Text field: The value to use for the ID to Search On field (must be a unique value).
Returns the matched object, or an empty object {} if no match is found and Allow zero results is enabled.
Lookups a set of objects based on a defined list of criteria. The results can be emitted in different ways.
Fetch all
, Fetch page
, Emit individually
, required.file
.Search Criteria Array: An array of search terms combined using the AND
operator.
Please note: HubSpot support up to three criteria.
Example:
Records created after 2021-10-01T03:30:17.883Z
with property firstname
containing Tony
.
["createdate GT 1633059017883", "firstname CONTAINS_TOKEN Tony"]
Supported operators:
OPERATOR | DESCRIPTION |
---|---|
EQ |
equal to |
NEQ |
not equal to |
LT |
less than |
LTE |
less than or equal to |
GT |
greater than |
GTE |
greater than or equal to |
HAS_PROPERTY |
has property value |
NOT_HAS_PROPERTY |
does not have property value |
CONTAINS_TOKEN |
contains token |
NOT_CONTAINS_TOKEN |
does not contain token |
If selected Fetch page
additional metadata fields:
Order example:
'createdate DESCENDING'
Fetch page
: An object with:
results
that has an array as its value.*totalCountOfMatchingResults
containing the total number of results (not just on the page) matching the search criteria.Fetch All
: An object, with key *results
that has an array as its value.Emit Individually
: Each object fill the entire message.Creates an association between two HubSpot objects.
Please note: We do not retrieve objects to associate dynamically. Check the HubSpot documentation to verify that the association between selected objects is possible.
Object with statusCode
key that represent result of request.
Removes an association between two HubSpot objects.
Please note: We do not retrieve objects to associate dynamically. Check the HubSpot documentation to verify that the association between selected objects is possible.
Object with statusCode
key that represent result of request.
Deletes a single object using a unique identifier.
ID value text field: value for ID to Search On
(unique field value by itself).
The expected output is an object with a id
property. id
value stands for id of delete object.
Upsert Object Action
-> any type of Lookup Object(s) Action
with enabled feature Enable download attachments
. Uploading the file to HubSpot on Upsert Object Action
takes some time, your might get 404
error on lookup.Click here to learn more about the elastic.io iPaaS