Paperless-ngx Integration

Document archive for scanning, tagging, and searching paper records. Turn Paperless-ngx updates into useful actions across the tools you already use. On Watch Config, notify the right channel, update a record, or trigger Autocomplete Search.

Explore Documentation

3-day trialCancel anytimeUp to 10 minutes quick set up

GDPR
Data Encryption
2FA
Local Data Region

Supported triggers and actions for Paperless-ngx integration

Triggers can detect changes in Paperless-ngx and run actions that can create, search or modify data inside Paperless-ngx automatically [3] — exactly how you set them.

Watch ConfigWatch for changes in app configuration.
Watch CorrespondentsWatch for changes in app correspondents.
Watch Custom FieldsWatch for changes in custom fields.
Watch Document HistoryWatch for changes in a documents history.
Watch DocumentsWatch for new documents.
Watch Document Share LinksWatch for changes in document share links.
Watch Document TypesWatch for changes in document types.
Watch GroupsWatch for changes in groups.
Watch Mail AccountsWatch for mail account changes.
Watch Mail RulesWatch for mail rule changes.
Watch Processed MailWatch for processed mail changes.
Watch Saved ViewsWatch for changes in saved views.
Watch Share LinksTriggers when a share links is created or updated.
Watch Storage PathsWatch for changes in storage paths.
Watch TagsWatch for changes in tags.
Watch TasksWatch for new tasks.
Watch UsersWatch for new user.
Watch WorkflowsWatch for new workflows.
Autocomplete SearchGet a list of all available tags.
Get a DocumentRetrieves details of a specific document by its ID.
Get App Config By IdGET /api/config/{id}/.
Get CorrespondentGET /api/correspondents/{id}/.
Get Custom FieldGET /api/custom_fields/{id}/.
Get Document Ai SuggestionsGET /api/documents/{id}/ai_suggestions/.
Get Document MetadataGET /api/documents/{id}/metadata/.
Get Document NotesView, add, or delete notes for the document.
Get Document RootGET /api/documents/{id}/root/.
Get Document SuggestionsGET /api/documents/{id}/suggestions/.
Get Document ThumbnailGET /api/documents/{id}/thumb/.
Get Document TypeGET /api/document_types/{id}/.
Get GroupGET /api/groups/{id}/.
Get LogGET /api/logs/{id}/.
Get Mail AccountGET /api/mail_accounts/{id}/.
Get Mail RuleGET /api/mail_rules/{id}/.
Get Next AsnGET /api/documents/next_asn/.
Get Processed MailGET /api/processed_mail/{id}/.
Get Remote VersionGET /api/remote_version/.
Get Saved ViewGET /api/saved_views/{id}/.
Get Selection DataPOST /api/documents/selection_data/.
Get Share LinkGET /api/share_links/{id}/.
Get Share Link BundleGET /api/share_link_bundles/{id}/.
Get Social Account ProvidersGets social Account Providers.
Get StatisticsGET /api/statistics/.
Get Storage PathGET /api/storage_paths/{id}/.
Get System StatusGET /api/status/.
Get TagGET /api/tags/{id}/.
Get Totp SecretGET /api/profile/totp/.
Get User ProfileGET /api/profile/.
List App ConfigGET /api/config/.
List CorrespondentsGET /api/correspondents/.
List Custom FieldsGET /api/custom_fields/.
List Document HistoryGET /api/documents/{id}/history/.
List Document Share LinksGET /api/documents/{id}/share_links/.
List Document TypesGET /api/document_types/.
List GroupsGET /api/groups/.
List LogsGET /api/logs/.
List Mail AccountsGET /api/mail_accounts/.
List Mail RulesGET /api/mail_rules/.
List Processed MailGET /api/processed_mail/.
List Saved ViewsGET /api/saved_views/.
List Share Link BundlesGET /api/share_link_bundles/.
List Share LinksGET /api/share_links/.
List Storage PathsGET /api/storage_paths/.
List TagsGET /api/tags/.
List TasksGET /api/tasks/.
Search DocumentsFull text searching on documents.
Activate TotpValidates a TOTP code and activates the TOTP authenticator.
Bulk Delete Processed MailDelete multiple processed mail records by ID.
Bulk Download DocumentsPOST /api/documents/bulk_download/.
Bulk Edit DocumentsPerforms the edit Documents operation.
Chat With DocumentsPOST /api/documents/chat/.
Create CorrespondentPOST /api/correspondents/.
Create Custom FieldPOST /api/custom_fields/.
Create Document NotePOST /api/documents/{id}/notes/.
Create Document TypePOST /api/document_types/.
Create GroupPOST /api/groups/.
Create Mail AccountPOST /api/mail_accounts/.
Create Mail RulePOST /api/mail_rules/.
Create Saved ViewPOST /api/saved_views/.
Create Share LinkPOST /api/share_links/.
Create Share Link BundlePOST /api/share_link_bundles/.
Create Storage PathPOST /api/storage_paths/.
Create TagPOST /api/tags/.
Deactivate TotpDELETE /api/profile/totp/.
Delete a DocumentDeletes a document by its ID.
Delete App ConfigDELETE /api/config/{id}/.
Delete CorrespondentDELETE /api/correspondents/{id}/.
Delete Custom FieldDELETE /api/custom_fields/{id}/.
Delete Document NoteDELETE /api/documents/{id}/notes/.
Delete Document TypeDELETE /api/document_types/{id}/.
Delete Document VersionDELETE /api/documents/{id}/versions/{version_id}/.
Delete GroupDELETE /api/groups/{id}/.
Delete Mail AccountDELETE /api/mail_accounts/{id}/.
Delete Mail RuleDELETE /api/mail_rules/{id}/.
Delete Saved ViewDELETE /api/saved_views/{id}/.
Delete Share LinkDELETE /api/share_links/{id}/.
Delete Share Link BundleDELETE /api/share_link_bundles/{id}/.
Delete Storage PathDELETE /api/storage_paths/{id}/.
Delete TagDELETE /api/tags/{id}/.
Disconnect Social AccountPOST /api/profile/disconnect_social_account/.
Download a DocumentDownloads the binary content of a document by its ID.
Edit Pdf DocumentPOST /api/documents/edit_pdf/.
Email Bulk DocumentsPOST /api/documents/email/.
Global SearchGET /api/search/.
Make An API CallPerforms an arbitrary authorized API call.
Merge DocumentsPOST /api/documents/merge/.
Patch App ConfigPATCH /api/config/{id}/.
Patch CorrespondentPATCH /api/correspondents/{id}/.
Patch Custom FieldPATCH /api/custom_fields/{id}/.
Patch Document TypePATCH /api/document_types/{id}/.
Patch Document Version LabelPATCH /api/documents/{id}/versions/{version_id}/.
Patch GroupPATCH /api/groups/{id}/.
Patch Mail AccountPATCH /api/mail_accounts/{id}/.
Patch Mail RulePATCH /api/mail_rules/{id}/.
Patch Saved ViewPATCH /api/saved_views/{id}/.
Patch Share Link BundlePATCH /api/share_link_bundles/{id}/.
Patch Storage PathPATCH /api/storage_paths/{id}/.
Patch TagPATCH /api/tags/{id}/.
Preview DocumentGET /api/documents/{id}/preview/.
Process Mail AccountPOST /api/mail_accounts/{id}/process/.
Rebuild Share Link BundlePOST /api/share_link_bundles/{id}/rebuild/.
Remove Pdf PasswordPOST /api/documents/remove_password/.
Replace DocumentPUT /api/documents/{id}/.
Reprocess DocumentsPOST /api/documents/reprocess/.
Rotate DocumentsPOST /api/documents/rotate/.
Test Mail AccountPOST /api/mail_accounts/test/.
Test Storage PathPOST /api/storage_paths/test/.
Trash DocumentsPOST /api/documents/delete/.
Update a DocumentUpdates metadata of an existing document.
Update App ConfigPUT /api/config/{id}/.
Update CorrespondentPUT /api/correspondents/{id}/.
Update Custom FieldPUT /api/custom_fields/{id}/.
Update Document TypePUT /api/document_types/{id}/.
Update Document VersionPOST /api/documents/{id}/update_version/.
Update GroupPUT /api/groups/{id}/.
Update Mail AccountPUT /api/mail_accounts/{id}/.
Update Mail RulePUT /api/mail_rules/{id}/.
Update Saved ViewPUT /api/saved_views/{id}/.
Update Share Link BundlePUT /api/share_link_bundles/{id}/.
Update Storage PathPUT /api/storage_paths/{id}/.
Update TagPUT /api/tags/{id}/.
Update User ProfilePATCH /api/profile/.
Upload a DocumentUploads a Document.

How to integrate Paperless-ngx in automation workflow?

3 simple steps to make your Paperless-ngx connected with other apps in automation workflows on WEXTL. Up to 10 minutes integration set up.

STEP 1

Select Paperless-ngx in workflow

Pick Paperless-ngx app in the workflow builder [4] - just one click to select the app.

STEP 2

Connect Paperless-ngx

When prompted, authorize access to Paperless-ngx in WEXTL once. Paperless-ngx credentials are encrypted and never shared with WEXTL. Authorization will be reused in any future API calls [3].

WEXTL wants to integrate with your Paperless-ngx account. Approve?

STEP 3

Build a workflow

Build your workflow with Paperless-ngx yourself or with WEXTL® AI Builder. Connect Paperless-ngx to any available integrations [5], or use HTTP node to go beyond them.

Paperless-ngx

How Paperless-ngx connects and integrates with WEXTL

Save and approve your credentials once — WEXTL® stores authorization information encrypted and reuses the authentication whenever Paperless-ngx app is called in workflows. That allows your productivity automations to run without your attention, per defined schedule [7]. Explore documentation [6] for a detailed list of fields that Paperless-ngx supports.

Full Paperless-ngx API documentation

The following table illustrates what fields Paperless-ngx integration require during authorization flow inside our workflow builder [4].

Demonstration of Paperless-ngx connection step inside WEXTL Workflow Builder [4].

Field	Type	Help
API KeyRequired	password	Login in to your dashboard, click on 'My Profile', and copy your apiKey.
Base UrlRequired	url	Please enter the base url of your host server, e.g http://example.com/

Connect Paperless-ngx to popular apps on WEXTL

Enter a name of the other app you want to sync with Paperless-ngx below. Click on selected app to explore integration options with Paperless-ngx. If the app you search for is not available in WEXTL yet, you can use HTTP node [10] instead to integrate it directly.

Example automation with Paperless-ngx integration

Select Watch Document Share Links trigger from Paperless-ngx - this will be a starting point in your automation. Whenever event happens in Paperless-ngx, workflow will start [7] from Watch Document Share Links node.

Search for Create Document Note, connect it as the next step of integration sequence. You can use filters between Watch Document Share Links and Create Document Note, so only important data pass from Watch Document Share Links to the next step. WEXTL gives you full control over the process of Paperless-ngx automation. All parts of workflow are visible on the canvas [4].

Paperless-ngx on WEXTL has 143 modules for building productivity automations. Explore Paperless-ngx documentation for more.

Paperless-ngx

Watch Document Share Links

Formstack Documents

Performs action

Formstack Documents

Triggers

Paperless-ngx

Create Document Note

Demonstration of how visual Paperless-ngx automation [6] looks in WEXTL.

Frequently asked questions

Common questions about automating Paperless-ngx in your workflows.

Paperless-ngx has 18 triggers, including "Watch Config", "Watch Correspondents", and "Watch Custom Fields", and more. Triggers are start points of the workflow, and automations may start from them.

Integration has 125 actions, including "Autocomplete Search", "Get a Document", and "Get App Config By Id", and more. Refer to our Paperless-ngx Documentation for detailed inputs and outputs.

No. Most automations are built visually on the canvas by picking triggers, actions, and mapping fields. You can add custom JavaScript with Functions when advanced logic is needed — but our customers do that in rare cases [4].

Yes. Connections are authenticated per account, credentials are encrypted at rest, and you can enforce approvals and team-level access controls on any automation.

The Paperless-ngx integration on WEXTL runs directly on its vendor public API — every field name, authentication method, and rate limit is controlled by Paperless-ngx official API and covered in documentation [3]. WEXTL handles the request signing and pagination for you.

Absolutely. Where Paperless-ngx provides native webhooks, you can use instant triggers to eliminate polling delay. For custom webhooks, WEXTL offers Custom Webhook node, so you can start automation whenever Paperless-ngx or any other service sends event to webhook URL.

WEXTL is an AI-first visual canvas. The platform allows you to describe automation in plain text — and AI will wire nodes for Paperless-ngx inside the workflow builder [4]. You can also use built-in workflow nodes (AI Agent, Human in the Loop, Condition, Aggregate Results) in pair with Paperless-ngx modules to craft complex integration flows with branches, filtering, and conditional logic. There are absolutely no limits of what you can build.

References

List of sources used to gather information about the Paperless-ngx integration.

Paperless-ngx integration source code, module specs and credentials implementation.
Internal Paperless-ngx integration documentation, structured input and output parameters, scopes, and authentication methods.
Official Paperless-ngx vendor API documentation — used to verify field meanings, authentication flows, and anything our own specs don't fully capture.
WEXTL® Visual Workflow Builder, anonymized data from our technical support team.
WEXTL® Apps Library
WEXTL® Paperless-ngx App Documentation
WEXTL® Workflow Scheduler
WEXTL® HTTP node documentation

Paperless-ngx Integration

Supported triggers and actions for Paperless-ngx integration