FruxonDocs
Agent NetworkTriggers

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.

POST
/v1/tenants/{tenant}/triggers/{trigger}/ledger/items/{item}/effects/{effect}:settle
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

trigger*string

The automation.

Formatuuid
item*string

The ledger item identifier.

Formatuuid
effect*string

The effect identifier.

Formatuuid
tenant*string

The tenant identifier

What the operator found, and how they know.

outcome*string

What the operator found in the external system. Required.

Value in"UNSPECIFIED" | "LANDED" | "DID_NOT_LAND"
reason*string

How they know — the row they saw, the id they searched. Required.

Length1 <= length <= 4000
externalRef?string|null

The external handle, when settling as landed and the operator has one. Recorded so a hand-settled effect is as auditable as a reconciled one.

Lengthlength <= 4000
[key: string]?never

Response Body

curl -X POST "https://api.fruxon.com/v1/tenants/string/triggers/497f6eca-6276-4993-bfeb-53cbbbba6f08/ledger/items/497f6eca-6276-4993-bfeb-53cbbbba6f08/effects/497f6eca-6276-4993-bfeb-53cbbbba6f08:settle" \  -H "Content-Type: application/json" \  -d '{    "outcome": "UNSPECIFIED",    "reason": "string"  }'
{
  "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
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}