Skip to content
Proud to collaborate with Microsoft for Startups

identity.notification-pref.query ​

List active notification preferences for the authenticated user

List notification preferences for the authenticated user (actor).

Always scoped to the actor — never returns other users' preferences. Only active preferences (deleted_at IS NULL) are returned.

Inputs:

  • actor: Cognito sub (required)
  • organization_uuid: Optional org scope

Outputs (terminal state_data):

  • preferences: list of preference dicts (no int ids)
  • count: number of preferences returned

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
actorstringYes—Cognito sub of the authenticated user
organization_uuiduuidNo—Optional: restrict results to a single organization

Output Schema ​

FieldTypeRequiredDefaultDescription
actorstringNo——
organization_uuiduuidNo——
preferenceslistYes——
countintegerYes——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "identity.notification-pref.query",
  "initial_data": {
    "actor": "value"
  }
}