One item's durable side effects, and how sure the platform is about each.
External effects recorded for this item. UNKNOWN means an earlier attempt has an unresolved result: the platform refuses to repeat it, including after re-drive, and the item cannot advance. canSettle identifies effects an operator can settle after verifying the external result.
Authorization
Bearer JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.
In: header
Path Parameters
The automation.
uuidThe ledger item identifier.
uuidThe tenant identifier
Query Parameters
The maximum number of items to return per page
int32int32Opaque pagination token returned by an external service. Pass it back unchanged rather than interpreting it as an offset.
Response Body
curl -X GET "https://api.fruxon.com/v1/tenants/string/triggers/497f6eca-6276-4993-bfeb-53cbbbba6f08/ledger/items/497f6eca-6276-4993-bfeb-53cbbbba6f08/effects"{
"items": [
{
"id": "00000000-0000-0000-0000-000000000000",
"ledgerItemId": "00000000-0000-0000-0000-000000000000",
"effectKey": "string",
"status": "PENDING",
"externalRef": "string",
"detail": "string",
"attempts": 0,
"executionRecordId": "00000000-0000-0000-0000-000000000000",
"createdAt": 0,
"modifiedAt": 0,
"resolvedAt": 0,
"canSettle": false
}
],
"nextPageToken": "string",
"totalCount": 0
}{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}Starts one work item by hand.
For an automation whose work shape declares an `onDemand` block: admits one item at its first stage, from `data` checked against the block's declared inputs. The item key is `itemKey`, or composed from `data` at the block's `keyPaths`; when both are given they must agree. A credential-named key anywhere in `data` is refused — store the value in Secrets. <b>Idempotent on the key.</b> 201 with `created: true` for a new item; 200 with `created: false` and the item that already holds the key, unchanged, whatever its status and whatever this call's data says — never a 409. Corrections go through `:setData`; a finished item is not restarted. A repeatable operation needs its occurrence (an invoice number, a cycle) among the key paths. A paused automation still admits; `paused: true` says nothing will work the item until it is resumed. `stageId` is refused: an item starts at the first stage. Needs `triggers:fire`.
Records what a person found about an effect the platform could not resolve.
The way out of an UNKNOWN effect, which otherwise parks its item permanently. The operator checks the external system and answers the question the platform could not: `LANDED` closes the effect so a later attempt skips the call, `DID_NOT_LAND` reopens it so the next attempt performs it. Answer it wrong in the second direction and the effect is duplicated — which is the failure the durable-effect record exists to prevent — so the reason is required, and only an `UNKNOWN` effect may be settled at all. Returns 409 for any other status: a PENDING row may have a worker mid-call against it. Settling does not re-drive the item; that stays a separate decision.