Integrations
Queue HubSpot outgoing sync
Queues processing of pending/failed outgoing work using current approved provider mappings and settings. limit defaults to 100, maximum 500. The worker may create/update provider records; HTTP 202 confirms queued work and does not report completed sends. Requires the integration platform global/configured client feature gate (normally integration_platform_foundation). Requires permission: one of access_account_settings.
POST
/
integrations
/
hub
/
connections
/
{connection_id}
/
hubspot
/
outbound-sync
Queue HubSpot outgoing sync
curl --request POST \
--url https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/hubspot/outbound-sync \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"limit": 1
}'import requests
url = "https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/hubspot/outbound-sync"
payload = { "limit": 1 }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({limit: 1})
};
fetch('https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/hubspot/outbound-sync', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/hubspot/outbound-sync",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'limit' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/hubspot/outbound-sync"
payload := strings.NewReader("{\n \"limit\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/hubspot/outbound-sync")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"limit\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/hubspot/outbound-sync")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"limit\": 1\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"sync_run_id": 42,
"sync_run": {
"id": 42,
"connection_id": 42,
"provider_key": "hubspot",
"run_type": "Example",
"trigger_source": "Example",
"direction": "Example",
"status": "Example",
"object_types_json": [
"<string>"
],
"counters_json": {
"created": 2,
"updated": 2,
"skipped": 2,
"failed": 2,
"conflicted": 2,
"retried": 2
},
"summary_json": {
"template_variant": "Example",
"metadata_snapshot_id": 42,
"metadata_snapshot_version": 2,
"context": {
"donor_hysform_id": 42,
"company_target_mode": "household",
"allow_email_match": true,
"company_match_by_name": true,
"activity_sync_enabled": true,
"activity_types": [
"note"
],
"activity_link_policy": "matched_only",
"activity_body_visibility": "team",
"deal_sync_enabled": true,
"deal_stage_ids": [
"<string>"
],
"product_sync_enabled": true,
"product_program_ids": [
42
],
"product_field_mapping": {
"name": "Example",
"description": "Example",
"price": "Example",
"sku": "Example"
},
"product_program_field_mappings": {},
"deal_outbound_enabled": true,
"deal_outbound_pipeline_id": "Example",
"deal_outbound_stage_id": "Example"
},
"context_errors": [
{
"code": "Example",
"message": "Example"
}
],
"mapping_reviews": [
{
"mapping_id": 42,
"hys_object_type": "Example",
"provider_object_type": "Example",
"status": "ready",
"warnings": [
"<string>"
],
"errors": [
"<string>"
],
"conflicts": [
"<string>"
]
}
],
"object_summaries": {},
"mode": "Example",
"processed_outbox_events": 2
},
"context_json": {},
"error_summary_json": {},
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
},
"message": "Example"
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}Authorizations
bearerAuthapiKeyAuth
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Connection id in the current organization.
Body
application/json
Validated request fields for this operation.
Limit. Validation: nullable, integer, min:1, max:500.
Required range:
1 <= x <= 500Example:
1
⌘I
Queue HubSpot outgoing sync
curl --request POST \
--url https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/hubspot/outbound-sync \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"limit": 1
}'import requests
url = "https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/hubspot/outbound-sync"
payload = { "limit": 1 }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({limit: 1})
};
fetch('https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/hubspot/outbound-sync', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/hubspot/outbound-sync",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'limit' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/hubspot/outbound-sync"
payload := strings.NewReader("{\n \"limit\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/hubspot/outbound-sync")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"limit\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/hubspot/outbound-sync")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"limit\": 1\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"sync_run_id": 42,
"sync_run": {
"id": 42,
"connection_id": 42,
"provider_key": "hubspot",
"run_type": "Example",
"trigger_source": "Example",
"direction": "Example",
"status": "Example",
"object_types_json": [
"<string>"
],
"counters_json": {
"created": 2,
"updated": 2,
"skipped": 2,
"failed": 2,
"conflicted": 2,
"retried": 2
},
"summary_json": {
"template_variant": "Example",
"metadata_snapshot_id": 42,
"metadata_snapshot_version": 2,
"context": {
"donor_hysform_id": 42,
"company_target_mode": "household",
"allow_email_match": true,
"company_match_by_name": true,
"activity_sync_enabled": true,
"activity_types": [
"note"
],
"activity_link_policy": "matched_only",
"activity_body_visibility": "team",
"deal_sync_enabled": true,
"deal_stage_ids": [
"<string>"
],
"product_sync_enabled": true,
"product_program_ids": [
42
],
"product_field_mapping": {
"name": "Example",
"description": "Example",
"price": "Example",
"sku": "Example"
},
"product_program_field_mappings": {},
"deal_outbound_enabled": true,
"deal_outbound_pipeline_id": "Example",
"deal_outbound_stage_id": "Example"
},
"context_errors": [
{
"code": "Example",
"message": "Example"
}
],
"mapping_reviews": [
{
"mapping_id": 42,
"hys_object_type": "Example",
"provider_object_type": "Example",
"status": "ready",
"warnings": [
"<string>"
],
"errors": [
"<string>"
],
"conflicts": [
"<string>"
]
}
],
"object_summaries": {},
"mode": "Example",
"processed_outbox_events": 2
},
"context_json": {},
"error_summary_json": {},
"started_at": "2023-11-07T05:31:56Z",
"finished_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
},
"message": "Example"
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}