create_workflow_trigger
Create a single standalone Paperless-ngx workflow trigger. It has no effect alone; build automations with create_workflow or edit triggers inside workflows.
Instructions
Create ONE standalone workflow trigger. On its own a trigger does nothing, and Paperless deletes triggers that belong to no workflow whenever any workflow is updated. To build an automation, use create_workflow with the triggers inline; to change a trigger inside a workflow, use update_workflow (or update_workflow_trigger with the trigger id from get_workflow).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | Trigger type: 1=consumption started, 2=document added, 3=document updated, 4=scheduled | |
| match | No | ||
| sources | No | Consumption-started (type 1) triggers only: consumption sources 1=consume folder, 2=API upload, 3=mail fetch, 4=web UI (default [1,2,3]) | |
| filter_path | No | Consumption-started (type 1) triggers only: consume-folder path pattern, * wildcards allowed | |
| is_insensitive | No | ||
| filter_filename | No | Filename pattern (the whole name must match, case-insensitive), * wildcards allowed. Works for every trigger type: at consumption start it checks the incoming file's name, for types 2–4 the document's original file name. | |
| filter_has_tags | No | Document has ANY of these tags. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet. | |
| filter_mailrule | No | Consumption-started (type 1) triggers only: only documents fetched by this mail rule ID | |
| matching_algorithm | No | Content match for `match`: 0=none, 1=any word, 2=all words, 3=exact, 4=regular expression, 5=fuzzy word. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet. | |
| filter_has_all_tags | No | Document has ALL of these tags. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet. | |
| filter_has_not_tags | No | Document has NONE of these tags. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet. | |
| schedule_date_field | No | Type 4: date the schedule is based on | |
| schedule_offset_days | No | Type 4: days to offset from schedule_date_field | |
| schedule_is_recurring | No | ||
| filter_custom_field_query | No | Custom-field filter as a JSON expression passed as a string. A condition is [field, operator, value], where field is the custom field's name or ID. Combine conditions with ["AND", [cond, …]] or ["OR", [cond, …]], and negate with ["NOT", cond]. Valid operators depend on the field's data type (e.g. exact, in, isnull, exists, icontains, gt, gte, lt, lte, range); pick an invalid one and Paperless names the valid ones. Examples: '["Amount", "gte", 100]', '["AND", [["Due", "lt", "2026-10-01"], ["Paid", "exact", false]]]'. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet. | |
| schedule_date_custom_field | No | Type 4 with schedule_date_field=custom_field: the date custom field ID | |
| filter_has_any_storage_paths | No | Storage path is one of these. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet. | |
| filter_has_not_storage_paths | No | Storage path is none of these. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet. | |
| filter_has_any_correspondents | No | Correspondent is one of these. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet. | |
| filter_has_any_document_types | No | Document type is one of these. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet. | |
| filter_has_not_correspondents | No | Correspondent is none of these. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet. | |
| filter_has_not_document_types | No | Document type is none of these. Checked for types 2–4 (added, updated, scheduled) only — not at consumption start, when the document has no content or metadata yet. | |
| schedule_recurring_interval_days | No |