Integrations
Check integration connection health
Calls the registered provider adapter, persists status/check time and current error state, and returns the updated safe connection plus provider-specific result. 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}
/
health-check
Check integration connection health
curl --request POST \
--url https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/health-check \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/health-check"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/health-check', 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}/health-check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/health-check"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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}/health-check")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/health-check")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"connection": {
"id": 2,
"client_id": 42,
"provider_key": "Example",
"connection_name": "Example",
"scope": "Example",
"auth_type": "Example",
"status": "Example",
"health_status": "Example",
"provider_account_id": 42,
"provider_tenant_id": 42,
"last_health_check_at": "2026-10-20T12:00:00Z",
"last_synced_at": "2026-10-20T12:00:00Z",
"last_error_at": "2026-10-20T12:00:00Z",
"last_error_code": "Example",
"last_error_message": "Example",
"disconnected_at": "2026-10-20T12:00:00Z",
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"unresolved_conflict_count": 2,
"credentials_configured": true,
"bloomerang_sync_readiness_enabled": true,
"settings_json": {},
"target_context_json": {},
"provider": {
"id": 42,
"display_name": "Example",
"category": "Example",
"status": "Example",
"supported_objects": {},
"capabilities": {}
},
"encrypted_credentials": {},
"metadata_snapshots": [
{
"id": 2,
"provider_key": "Example",
"snapshot_type": "Example",
"snapshot_version": 2,
"status": "Example",
"schema_hash": "Example",
"snapshot_json": {},
"metadata_json": {},
"discovered_at": "2026-10-20T12:00:00Z",
"approved_at": "2026-10-20T12:00:00Z",
"archived_at": "2026-10-20T12:00:00Z"
}
],
"recent_sync_runs": [
{
"id": 2,
"provider_key": "Example",
"run_type": "Example",
"trigger_source": "Example",
"direction": "Example",
"status": "Example",
"object_types_json": {},
"counters_json": {},
"summary_json": {},
"context_json": {},
"error_summary_json": {},
"started_at": "2026-10-20T12:00:00Z",
"finished_at": "2026-10-20T12:00:00Z",
"events": [
{
"id": 2,
"sync_run_id": 42,
"object_mapping_id": 42,
"provider_key": "Example",
"event_type": "Example",
"direction": "Example",
"status": "Example",
"hys_object_type": "Example",
"hys_object_id": 42,
"provider_object_type": "Example",
"provider_object_id": 42,
"dedupe_key": "Example",
"idempotency_key": "Example",
"retryable": true,
"attempts": 2,
"error_code": "Example",
"error_message": "Example",
"payload_json": {},
"payload_hash": "Example",
"occurred_at": "2026-10-20T12:00:00Z",
"processed_at": "2026-10-20T12:00:00Z"
}
]
}
],
"recent_conflicts": [
{
"id": 2,
"provider_key": "Example",
"conflict_type": "Example",
"status": "Example",
"hys_object_type": "Example",
"hys_object_id": 42,
"provider_object_type": "Example",
"provider_object_id": 42,
"conflicted_fields_json": {},
"hys_snapshot_json": {},
"provider_snapshot_json": {},
"detected_at": "2026-10-20T12:00:00Z",
"resolved_at": "2026-10-20T12:00:00Z",
"resolved_by": 42,
"resolution_json": {},
"relationship_identity": {
"kind": "relationship_identity",
"collision_reason": "Example",
"source": {
"provider_object_type": "Example",
"provider_object_id": "Example",
"source_provider_id": "Example",
"related_provider_id": "Example",
"source_name": "Example",
"related_name": "Example",
"relationship_type": "Example",
"reverse_relationship_type": "Example"
},
"current_mapping": {
"id": 42,
"hys_relationship_id": 42
},
"can_keep_separate": true,
"keep_separate_will_create": true,
"can_treat_as_same_or_reverse": true,
"expected_object_mapping_id": 42,
"stale_mapping_token": "<string>",
"pending_resolution": {
"decision": "Example",
"target_hys_object_id": 42,
"staged_at": "2023-11-07T05:31:56Z",
"verification_status": "Example"
},
"candidates": [
{
"id": 42,
"source_name": "Example",
"related_name": "Example",
"relationship_type": "Example",
"is_current": true,
"available": true
}
]
},
"recurring_schedule": {
"kind": "recurring_schedule",
"source": {
"provider_object_type": "Example",
"provider_object_id": "Example",
"donor_provider_id": "Example",
"currency": "Example",
"frequency": "Example",
"start_date": "Example",
"end_date": "Example",
"status": "Example",
"last_modified_at": "Example",
"amount": 125
},
"matched_donor": {
"id": 42,
"name": "Example"
},
"active_commitments": [
{
"id": 42,
"amount": 125,
"frequency": "Example",
"is_non_charging": true,
"is_external_processor": true
}
],
"active_commitment_count": 2,
"active_commitment_total": 125,
"mapped_commitment": {
"id": 42,
"amount": 125,
"frequency": "Example",
"is_non_charging": true,
"is_external_processor": true,
"mapping_id": 42
},
"can_mark_already_represented": true,
"expected_provider_object_id": "Example",
"source_snapshot_token": "<string>",
"active_commitment_token": "<string>"
}
}
]
},
"health_check": {
"status": "Example",
"message": "Example",
"data": {},
"checked_at": "2026-10-20T12:00:00Z"
}
}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}Authorizations
bearerAuthapiKeyAuth
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Connection id in the current organization.
⌘I
Check integration connection health
curl --request POST \
--url https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/health-check \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/health-check"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/health-check', 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}/health-check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/health-check"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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}/health-check")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/integrations/hub/connections/{connection_id}/health-check")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"connection": {
"id": 2,
"client_id": 42,
"provider_key": "Example",
"connection_name": "Example",
"scope": "Example",
"auth_type": "Example",
"status": "Example",
"health_status": "Example",
"provider_account_id": 42,
"provider_tenant_id": 42,
"last_health_check_at": "2026-10-20T12:00:00Z",
"last_synced_at": "2026-10-20T12:00:00Z",
"last_error_at": "2026-10-20T12:00:00Z",
"last_error_code": "Example",
"last_error_message": "Example",
"disconnected_at": "2026-10-20T12:00:00Z",
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"unresolved_conflict_count": 2,
"credentials_configured": true,
"bloomerang_sync_readiness_enabled": true,
"settings_json": {},
"target_context_json": {},
"provider": {
"id": 42,
"display_name": "Example",
"category": "Example",
"status": "Example",
"supported_objects": {},
"capabilities": {}
},
"encrypted_credentials": {},
"metadata_snapshots": [
{
"id": 2,
"provider_key": "Example",
"snapshot_type": "Example",
"snapshot_version": 2,
"status": "Example",
"schema_hash": "Example",
"snapshot_json": {},
"metadata_json": {},
"discovered_at": "2026-10-20T12:00:00Z",
"approved_at": "2026-10-20T12:00:00Z",
"archived_at": "2026-10-20T12:00:00Z"
}
],
"recent_sync_runs": [
{
"id": 2,
"provider_key": "Example",
"run_type": "Example",
"trigger_source": "Example",
"direction": "Example",
"status": "Example",
"object_types_json": {},
"counters_json": {},
"summary_json": {},
"context_json": {},
"error_summary_json": {},
"started_at": "2026-10-20T12:00:00Z",
"finished_at": "2026-10-20T12:00:00Z",
"events": [
{
"id": 2,
"sync_run_id": 42,
"object_mapping_id": 42,
"provider_key": "Example",
"event_type": "Example",
"direction": "Example",
"status": "Example",
"hys_object_type": "Example",
"hys_object_id": 42,
"provider_object_type": "Example",
"provider_object_id": 42,
"dedupe_key": "Example",
"idempotency_key": "Example",
"retryable": true,
"attempts": 2,
"error_code": "Example",
"error_message": "Example",
"payload_json": {},
"payload_hash": "Example",
"occurred_at": "2026-10-20T12:00:00Z",
"processed_at": "2026-10-20T12:00:00Z"
}
]
}
],
"recent_conflicts": [
{
"id": 2,
"provider_key": "Example",
"conflict_type": "Example",
"status": "Example",
"hys_object_type": "Example",
"hys_object_id": 42,
"provider_object_type": "Example",
"provider_object_id": 42,
"conflicted_fields_json": {},
"hys_snapshot_json": {},
"provider_snapshot_json": {},
"detected_at": "2026-10-20T12:00:00Z",
"resolved_at": "2026-10-20T12:00:00Z",
"resolved_by": 42,
"resolution_json": {},
"relationship_identity": {
"kind": "relationship_identity",
"collision_reason": "Example",
"source": {
"provider_object_type": "Example",
"provider_object_id": "Example",
"source_provider_id": "Example",
"related_provider_id": "Example",
"source_name": "Example",
"related_name": "Example",
"relationship_type": "Example",
"reverse_relationship_type": "Example"
},
"current_mapping": {
"id": 42,
"hys_relationship_id": 42
},
"can_keep_separate": true,
"keep_separate_will_create": true,
"can_treat_as_same_or_reverse": true,
"expected_object_mapping_id": 42,
"stale_mapping_token": "<string>",
"pending_resolution": {
"decision": "Example",
"target_hys_object_id": 42,
"staged_at": "2023-11-07T05:31:56Z",
"verification_status": "Example"
},
"candidates": [
{
"id": 42,
"source_name": "Example",
"related_name": "Example",
"relationship_type": "Example",
"is_current": true,
"available": true
}
]
},
"recurring_schedule": {
"kind": "recurring_schedule",
"source": {
"provider_object_type": "Example",
"provider_object_id": "Example",
"donor_provider_id": "Example",
"currency": "Example",
"frequency": "Example",
"start_date": "Example",
"end_date": "Example",
"status": "Example",
"last_modified_at": "Example",
"amount": 125
},
"matched_donor": {
"id": 42,
"name": "Example"
},
"active_commitments": [
{
"id": 42,
"amount": 125,
"frequency": "Example",
"is_non_charging": true,
"is_external_processor": true
}
],
"active_commitment_count": 2,
"active_commitment_total": 125,
"mapped_commitment": {
"id": 42,
"amount": 125,
"frequency": "Example",
"is_non_charging": true,
"is_external_processor": true,
"mapping_id": 42
},
"can_mark_already_represented": true,
"expected_provider_object_id": "Example",
"source_snapshot_token": "<string>",
"active_commitment_token": "<string>"
}
}
]
},
"health_check": {
"status": "Example",
"message": "Example",
"data": {},
"checked_at": "2026-10-20T12:00:00Z"
}
}
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}