Report an External Sync
/v1/graphs/{graph_id}/connections/{connection_id}/sync-reportPart of Connections.
For an external connection: the integration reports a run it just finished. The platform runs no sync for an external source, so this is how the connection's last_sync moves. A 'succeeded' report sets it to now; a 'failed' one records the outcome and leaves it. For an external ledger that keeps an entity's books, a period close reads last_sync to tell whether the books it mirrors are current. Refused (400) for a connection the platform syncs itself.
Authentication
Authenticate in any one of these ways — not all of them:
- API key in the
X-API-Keyheader. - Bearer token in the
Authorizationheader.
Path parameters
| Name | Type | Description |
|---|---|---|
graph_idrequired | string | Graph Id |
connection_idrequired | string | Unique connection identifier |
Request body
Required, application/json.
| Field | Type | Description |
|---|---|---|
statusrequired | string | 'succeeded' moves One of: |
countsoptional | object | What the run did, as the integration counts it (for example |
messageoptional | string | A line about the run: the window it covered, or why it failed. Constraints: at most 500 characters |
Example request
curl -X POST "https://api.robosystems.ai/v1/graphs/{graph_id}/connections/{connection_id}/sync-report" \
-H "X-API-Key: $ROBOSYSTEMS_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "succeeded"
}'Responses
200 Successful Response
| Field | Type | Description |
|---|---|---|
connection_idrequired | string | Unique connection identifier |
providerrequired | string | Connection provider type |
entity_idoptional | string | The entity whose books the connection keeps: the group parent for QuickBooks, the entity a bank feed was connected for (each of its accounts can move to another entity later), the entity an external ledger source was registered for, and none for any other external source, whose events name their own. |
keeps_booksoptional | boolean | Whether this connection is the ledger of record for Default: |
statusrequired | string | Connection status |
created_atrequired | string (date-time) | string | Creation timestamp |
updated_atoptional | string (date-time) | string | Last update timestamp |
last_syncoptional | string (date-time) | string | Last sync timestamp |
write_policyoptional | string | Outbound write policy: 'qb_authoritative' (QuickBooks is the book of record and RoboSystems-originated entries publish to it at close), 'shadow' (the connected ledger is the book of record, nothing is written to it and the close posts nothing locally; the only policy an external ledger source can hold), or 'native' (no external ledger; what severing leaves). It governs the books of |
source_nameoptional | string | External-provider registered source slug — the value the integration stamps on the events it emits. Null for platform providers. |
metadatarequired | object | Provider-specific metadata |
| Status | Meaning |
|---|---|
| 400 | Invalid request |
| 401 | Authentication required |
| 403 | Access denied |
| 404 | Resource not found |
| 422 | Validation Error |
| 429 | Rate limit exceeded |
| 500 | Internal server error |