External effect operations
2 operations named external.*. Every one runs in a batch through apply_ops, dry_run_ops, the CLI or the admin.
Updated
| Operation | What it does | Permission | Confirmation |
|---|---|---|---|
| external.status | Inspect a durable provider request without retrying its side effects. | site.admin | none |
| external.close | Close an interrupted provider reservation after inspecting domain state. | site.admin | destructive |
external.status
Inspect a durable provider request without retrying its side effects.
permission: site.adminreads onlyclass: read
Example input
{
"requestId": "0b7c6d5e-4f3a-4b2c-8d1e-9f0a1b2c3d4e"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| requestId | string (uuid) | yes |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| requestId | string (uuid) | yes | |
| state | string | yes | One of "running", "succeeded", "failed". |
| errorStatus | integer | null | yes |
Try it
yarn splash external.status '{"requestId":"0b7c6d5e-4f3a-4b2c-8d1e-9f0a1b2c3d4e"}' --dry-runexternal.close
Close an interrupted provider reservation after inspecting domain state. Cannot close a live request; never repeats provider actions.
permission: site.adminwrites: siteclass: transactionconfirm: destructiveundo: explicit recovery
Example input
{
"requestId": "0b7c6d5e-4f3a-4b2c-8d1e-9f0a1b2c3d4e"
}Input
| Field | Type | Required | Notes |
|---|---|---|---|
| requestId | string (uuid) | yes |
Output
| Field | Type | Required | Notes |
|---|---|---|---|
| requestId | string (uuid) | yes | |
| state | string | yes | One of "running", "succeeded", "failed". |
| errorStatus | integer | null | yes |
Needs confirmed: ["destructive"] on the batch, which the single-operation CLI form does not set: put it in a batch file and run yarn splash apply <file> --dry-run.
Generated from the operation registry and the MCP tool catalogue (source c24bb94cdd2e6a6e).
Something wrong on this page? Write to docs@librettocms.com.