Docs / Reference / act: webhook

act: webhook.

The address, what to be told about, and a secret to sign with to the row

Figure 1POST /v1/act/webhookspecified

The caller sends WebhookInput to /v1/act/webhook. The platform returns a card whose body is Telling.

POST/v1/act/webhook

Register an address to be told at. The call needs the tenant rung under a token with the act grant, and it is served by the platform.

The route takes WebhookInput and returns a card whose body is Telling.

Request body#

The request body is WebhookInput.

field	type	required	note
`telling`	Telling	yes

Response#

The route returns a card whose body is Telling. 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 tenant rung and a token with the act grant. The platform serves this route.

Example#

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

Example

curl -X POST https://api.scaleintelligence.co/v1/act/webhook \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "telling": { "tenant": "…", "address": "…", "kinds": [], "secret": "…", "tries_bound": 0, "failed_calls": [] } }'

import { client } from "@scale/sdk";
const answer = await client.act.webhook({
    "telling": {
      "tenant": "…",
      "address": "…",
      "kinds": [],
      "secret": "…",
      "tries_bound": 0,
      "failed_calls": []
    }
  });
// answer.body is a Telling. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/webhook",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "telling": {
        "tenant": "…",
        "address": "…",
        "kinds": [],
        "secret": "…",
        "tries_bound": 0,
        "failed_calls": []
      }
    }).json()

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

MCP tool#

The MCP tool si.act.webhook 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/Telling. The tool’s page describes it.

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

{
  "telling": {
    "tenant": "…",
    "address": "…",
    "kinds": [],
    "secret": "…",
    "tries_bound": 0,
    "failed_calls": []
  }
}

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

Claims#

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