Skip to Content

Report a sync run

An optional call after each scheduled sync run.

If you run a scheduled sync, tell us after each run. Your CharpstAR contact then sees when your system last synced and whether it went well.

Report a run

POST/api/v1/integration/heartbeatproducts:write

Send a name for your sync, the start time of the run, the number of products read, sent and written back, and up to 20 error messages. The reference page lists every field.

curl -sS https://platform.charpstar.co/api/v1/integration/heartbeat \
  -H "Authorization: Bearer $CHARPSTAR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "displayName": "Nightly catalogue sync", "run": { "startedAt": "2026-10-20T02:00:00Z", "read": 412, "sent": 12, "writtenBack": 3, "errors": [] } }'

On this page