Docs / Reference / act: sync rule

act: sync rule.

The installed connector, the offer, the fields of section 2.8 to the rule; for a preview, what it would read and push

Figure 1POST /v1/act/sync_rulespecified

The caller sends SyncRuleInput to /v1/act/sync_rule. The platform returns a card whose body is SyncPreview.

POST/v1/act/sync_rule

Write, preview and arm a sync rule. The call needs the brand rung under a token with the act grant, and it is served by the platform.

The route takes SyncRuleInput and returns a card whose body is SyncPreview.

Request body#

The request body is SyncRuleInput.

field	type	required	note
`rule`	SyncRule	yes
`flow`	`one of write \| preview \| arm \| disarm`	yes

Response#

The route returns a card whose body is SyncPreview. Every card ends with a foot that states the basis of each number, the scope of the call, and the time when the facts were true.

Headers#

header	required	meaning
`Scale-Scope`	yes	the scope the call runs in: tenant/, then /brand/, then /strategy/
`Scale-As-True-On`	no	the date the facts must have been true on; defaults to now
`Scale-As-Known-On`	no	the date the facts must have been known on; defaults to now
`Scale-Key`	no	for a change, the key made from the input; a repeat under the same key returns the unit held and writes nothing

A caller needs the brand rung and a token with the act grant. The platform serves this route.

Example#

The example sends the smallest body that SyncRuleInput allows. The build validates it against the schema of SyncRuleInput.

Example

curl -X POST https://api.scaleintelligence.co/v1/act/sync_rule \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "rule": { "installed_connector": "…", "offer": { "reading": "…", "action": "…", "identity_link": "…", "directions": [] }, "direction": "pull", "push_mappings": [], "conflict": "the source wins", "grant": "…", "state": { "ready": false, "since": "…" } }, "flow": "write" }'

import { client } from "@scale/sdk";
const answer = await client.act.sync_rule({
    "rule": {
      "installed_connector": "…",
      "offer": {
        "reading": "…",
        "action": "…",
        "identity_link": "…",
        "directions": []
      },
      "direction": "pull",
      "push_mappings": [],
      "conflict": "the source wins",
      "grant": "…",
      "state": {
        "ready": false,
        "since": "…"
      }
    },
    "flow": "write"
  });
// answer.body is a SyncPreview. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/sync_rule",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "rule": {
        "installed_connector": "…",
        "offer": {
          "reading": "…",
          "action": "…",
          "identity_link": "…",
          "directions": []
        },
        "direction": "pull",
        "push_mappings": [],
        "conflict": "the source wins",
        "grant": "…",
        "state": {
          "ready": false,
          "since": "…"
        }
      },
      "flow": "write"
    }).json()

let answer: Card = client.post("https://api.scaleintelligence.co/v1/act/sync_rule")
    .header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
    .json(&SyncRuleInput { /* the fields of the page */ }).send().await?.json().await?;

MCP tool#

The MCP tool si.act.sync_rule takes the same input and returns the same card. The tool changes data and needs a grant. An MCP host that renders cards draws this card from ui://scale-intelligence/cards/SyncPreview. The tool’s page describes it.

POST /v1/act/sync_rule
Scale-Scope: …
Scale-As-True-On: …
Scale-As-Known-On: …
Scale-Key: …
content-type: application/json

{
  "rule": {
    "installed_connector": "…",
    "offer": {
      "reading": "…",
      "action": "…",
      "identity_link": "…",
      "directions": []
    },
    "direction": "pull",
    "push_mappings": [],
    "conflict": "the source wins",
    "grant": "…",
    "state": {
      "ready": false,
      "since": "…"
    }
  },
  "flow": "write"
}

Without a key, this page shows the request only. The request body is SyncRuleInput, and the route returns a card whose body is SyncPreview.

Claims#

claim	state	route or tool
The platform serves the route /v1/act/sync_rule at contract 0476e35e6e275db5.	target	`/v1/act/sync_rule`