docs(n8n-webhook): add operator approval runbook
This commit is contained in:
@@ -48,6 +48,22 @@ Recommended request shape:
|
||||
}
|
||||
```
|
||||
|
||||
## Approval defaults by family
|
||||
|
||||
- notification family
|
||||
- `send_notification_draft`
|
||||
- `approval.family = "notification"`
|
||||
- `approval.required = true`
|
||||
- `approval.mutation_level = "high"`
|
||||
- Gmail family
|
||||
- read-only: `list_email_drafts` → `approval.family = "gmail"`, `approval.mutation_level = "low"`
|
||||
- mutating: `send_email_draft`, `delete_email_draft`, `send_gmail_draft` / `send_approved_email` → `approval.family = "gmail"`, `approval.mutation_level = "high"`
|
||||
- Calendar family
|
||||
- read-only: `list_upcoming_events` → `approval.family = "calendar"`, `approval.mutation_level = "low"`
|
||||
- mutating: `create_calendar_event`, `update_calendar_event`, `delete_calendar_event` → `approval.family = "calendar"`, `approval.mutation_level = "high"`
|
||||
- manual/generic approvals
|
||||
- `approval_queue_add` leaves side effects to the operator; there is no automatic host executor for arbitrary manual kinds
|
||||
|
||||
## Live actions in the shipped workflow asset
|
||||
|
||||
### `append_log`
|
||||
@@ -362,6 +378,9 @@ Request:
|
||||
Purpose:
|
||||
- inspect pending approval items
|
||||
- optionally include recent resolved history
|
||||
- returns both raw entries and compact operator-friendly summaries at:
|
||||
- `result.pending_compact`
|
||||
- `result.history_compact`
|
||||
|
||||
### `approval_queue_resolve`
|
||||
|
||||
@@ -405,6 +424,11 @@ Request:
|
||||
Purpose:
|
||||
- patch a resolved history item with host-side execution metadata after a real executor runs outside n8n
|
||||
- intended for bridges such as `gog`-backed Gmail/Calendar execution
|
||||
- compact execution reporting should populate or expose:
|
||||
- `execution.summary`
|
||||
- `execution.result_refs`
|
||||
- `item.operator.summary_line`
|
||||
- `item.operator.execution_state`
|
||||
|
||||
### `fetch_and_normalize_url`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user