Skip to content
Proud to collaborate with Microsoft for Startups

identity.notification-pref.create ​

Create a notification preference for the current user + org

Create a notification preference row for the current user + organization.

Inputs:

  • actor: Cognito sub or user UUID (required)
  • organization_uuid: Organization ID (required)
  • in_app_enabled, email_enabled, email_digest (optional)
  • quiet_hours_enabled, quiet_hours_start, quiet_hours_end, quiet_hours_timezone (optional)

Outputs (terminal state_data):

  • preference_uuid
  • persisted: true if created/restored, false if already existed

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-identity
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
actorstringYes——
organization_uuiduuidYes——
in_app_enabledbooleanNo——
email_enabledbooleanNo——
email_digeststringNo——
quiet_hours_enabledbooleanNo——
quiet_hours_startstringNo——
quiet_hours_endstringNo——
quiet_hours_timezonestringNo——

Output Schema ​

FieldTypeRequiredDefaultDescription
actorstringNo——
organization_uuiduuidNo——
preference_uuidstringNo——
persistedbooleanYes——
restoredbooleanNo——
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.create",
  "initial_data": {
    "actor": "value",
    "organization_uuid": "value"
  }
}