If a specific record is to be transferred via a HubEngine trigger, this can be done via the HubEngine trigger. Both the Action URL and the Trigger URL offer the option of sending individual record IDs when called.
The following explains how to use each of these features.
The two options differ in the number of records that can be sent.
With the Trigger URL, multiple records can be triggered by a send request, whereas with the Action URL, only one record can be sent per direction.
In the explanation the terms “primary” and “secondary” are used. Since a HubEngine plan always consists of two connected systems, it is necessary to distinguish from which system a record is to be transferred. (source of change)
The “primary” system is always the left system in a plan view and the “secondary” system is always the right system.
So if you have a plan between Hubspot and Microsoft Dynamics, the “primary” system is Hubspot and the “secondary” system is Microsoft Dynamics. This is then the reference when calling the trigger URL and the action URL.
Trigger-URL
Since the trigger URL endpoint can only be addressed via a POST/PUT request, IDs must be passed via the JSON body. This should look something like this
POST https://integration.hubengine.eu/hook/trigger/abcd1234
{ "primary": ["idA", "idB", "idC"], "secondary": ["id1", "id2", "id3"] }
The primary and secondary keys can be used, each containing a list of IDs to be transferred with the call. Transmission is optional, i.e. it does not have to be specified.
Up to 5,000 IDs can be transferred in each direction, i.e. a maximum of 10,000 records can be reported for transfer in one request.
If IDs are transferred in this way, the HubEngine will skip retrieving any changed records for that schedule run.
Action-URL
As the action URL can only be accessed via a GET request, it can be used to trigger the submission of a single record.
GET https://integration.hubengine.eu/hook/trigger/abcd1234?primary=idA
The ‘primary’ and/or ‘secondary’ parameters can be used to have exactly one record transferred from the HubEngine.
This call also skips the retrieval of modified records for this schedule run.
Rate Limit
Each Endpoint is limited to 6 requests per minute. When the rate limit is reached, the HubEngine returns a 429 Too many requests response.