Plugin heartbeat

POST/connector/heartbeat

Authorization

X-Sarvex-SignatureAPI key · headerrequired

HMAC-SHA256 signature over the raw request body plus the X-Sarvex-Timestamp and X-Sarvex-Sequence headers, keyed by the per-connector signing secret issued at pairing. Used only by the store plugin for /connector/*. Replays (seen sequence) are rejected with 409.

Request body

requiredapplication/json

plugin_versionstring

platform_versionstring

site_urlstring<uri>

healthyboolean

Responses

204

Heartbeat recorded.

401

Missing or invalid credentials.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

detailsobject | null

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Bodyapplication/json

plugin_versionstringplatform_versionstringsite_urlstringhealthyboolean

Request

curl -X POST "https://api.sarvex.example.com/v1/connector/heartbeat" \
  -H "X-Sarvex-Signature: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "plugin_version": "string",
  "platform_version": "string",
  "site_url": "http://example.com",
  "healthy": true
}'

const response = await fetch("https://api.sarvex.example.com/v1/connector/heartbeat", {
  method: "POST",
  headers: {
    "X-Sarvex-Signature": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: "{\n  \"plugin_version\": \"string\",\n  \"platform_version\": \"string\",\n  \"site_url\": \"http://example.com\",\n  \"healthy\": true\n}"
});

import requests

response = requests.post(
    "https://api.sarvex.example.com/v1/connector/heartbeat",
    headers={
        "X-Sarvex-Signature": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    data="{\n  \"plugin_version\": \"string\",\n  \"platform_version\": \"string\",\n  \"site_url\": \"http://example.com\",\n  \"healthy\": true\n}",
)

Response

Heartbeat recorded.

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}