queue.ack

Complete a claimed or running queue item and release its partition key.

Mark an item successfully finished, releasing its partition key.

Overview

Property	Value
Workflow type	Atomic
Library	App-queue
Version	1.0

Input Schema

Field	Type	Required	Default	Description
organization_uuid	string	Yes	—	—
item_uuid	string	Yes	—	—
reason	string	No	—	—

Output Schema

Field	Type	Required	Default	Description
item	json	No	—	—
item_uuid	string	No	—	—
status	string	No	—	—
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_action	string	No	—	—
failed_at_state	string	No	—	—
failed_layer	string	No	—	—
failed_step	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—
reason	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Accepted
completed	No	Yes	Yes	—	Completed
failed	No	Yes	No	—	Failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Run the queue operation
* (any state)	fail	failed	Mark failed

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "queue.ack",
  "initial_data": {
    "organization_uuid": "value",
    "item_uuid": "value"
  }
}