Appearance
notification.email.send ​
Send an Orkestia-owned transactional email
Send an Orkestia-owned transactional email.
Inputs:
- template: approved template name (required)
- to/template-specific fields only; raw subject/body/from are not accepted
Outputs:
- provider, provider_workflow_type, provider_workflow_ref
- email_ref/message_ref, status
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-identity |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
template | string | Yes | — | — |
to | No | — | — | |
to_role | string | No | — | — |
organization_uuid | uuid | No | — | — |
invitation_uuid | uuid | No | — | — |
invitation_token | string | No | — | — |
role | string | No | — | — |
message | string | No | — | — |
expires_at | datetime | No | — | — |
resend | boolean | No | — | — |
user_uuid | string | No | — | — |
user_email | No | — | — | |
user_name | string | No | — | — |
reason | string | No | — | — |
requested_at | string | No | — | — |
invite_token | string | No | — | — |
app_name | string | No | — | — |
workspace_name | string | No | — | — |
has_credentials | boolean | No | — | — |
verification_token | string | No | — | — |
landing_url | string | No | — | — |
return_to | string | No | — | — |
identity_app_uuid | uuid | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
template | string | Yes | — | — |
to | No | — | — | |
to_role | string | No | — | — |
organization_uuid | uuid | No | — | — |
identity_app_uuid | uuid | No | — | — |
invitation_uuid | uuid | No | — | — |
role | string | No | — | — |
provider | string | No | — | — |
provider_workflow_type | string | No | — | — |
provider_workflow_ref | string | No | — | — |
email_ref | string | No | — | — |
message_ref | string | No | — | — |
status | string | No | — | — |
sent_at | string | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | 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 ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "notification.email.send",
"initial_data": {
"template": "value"
}
}