identity.notification-pref.get

Fetch a single notification preference by UUID, ownership-verified

Fetch a single notification preference by UUID with ownership verification.

The preference must belong to both the given organization_uuid and the actor identified by actor (cognito_sub or uuid). Any mismatch resolves to COMPLETED with found=False — never FAILED.

Inputs:

• preference_uuid: UUID of the preference row (required)
• organization_uuid: Organization ID (required) — tenant check
• actor: Cognito sub or user UUID (required) — ownership check

Outputs (terminal state_data):

• preference: dict | None
• found: bool

Overview

Property	Value
Workflow type	Atomic
Library	App-identity
Version	1.0

Input Schema

Field	Type	Required	Default	Description
preference_uuid	uuid	Yes	—	UUID of the UserNotificationPreference row
organization_uuid	uuid	Yes	—	Organization UUID for tenant verification
actor	string	Yes	—	Cognito sub or user UUID for ownership verification

Output Schema

Field	Type	Required	Default	Description
preference_uuid	string	No	—	—
organization_uuid	uuid	No	—	—
actor	string	No	—	—
preference	json	No	—	—
found	boolean	Yes	—	—
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_action	string	No	—	—
failed_at_state	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

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

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	—
* (any state)	fail	failed	—

API Usage

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

{
  "workflow_type": "identity.notification-pref.get",
  "initial_data": {
    "preference_uuid": "value",
    "organization_uuid": "value",
    "actor": "value"
  }
}