Connect n8n and run your first workflow

Use n8n when you need to connect DocuWriter generation results with repository events, notifications, or another business tool. For keeping an existing documentation Space aligned with repository changes, start by evaluating Autopilot.

Connect the node

Search the n8n node picker for DocuWriter.ai. If it is unavailable, check your instance’s community-node policy. On installations that allow manual community packages, install n8n-nodes-docuwriter-ai through Settings → Community Nodes.

Create a DocuWriter.ai API credential in n8n with your DocuWriter API token and base URL https://app.docuwriter.ai. Keep the token in n8n credentials, not a workflow text field. See API setup for account-token prerequisites. This integration uses API credentials; it is separate from MCP OAuth.

Make the first execution a read

  1. Create a workflow with a manual trigger.
  2. Add the DocuWriter.ai action node and select your credential.
  3. Choose User Info and execute the node.
  4. Confirm that the account returned is the one you intend to automate.

Then try Code Documentation → Generate with a small, non-sensitive example file. Supply the filename and actual source content. Inspect the returned generation before adding downstream publishing steps. Generator calls can consume your account’s credits.

Choose an action or trigger

The action node supports code documentation, tests, comments, UML, optimization, generation retrieval, and account information. The DocuWriter.ai Trigger node listens for generation-created or generation-updated events. Select the event and connect its reachable webhook URL to a DocuWriter subscription. Use the production webhook URL for an active workflow; temporary test listeners are for an attended test run.

Not every DocuWriter API capability appears in the packaged node. Use an n8n HTTP Request step with the documented API when you need another supported endpoint.

If a read fails, fix credentials first. If generation fails, check required inputs, account permissions, and credits. If a trigger is silent, check subscription status, event selection, and URL reachability. Continue with workflow patterns and outgoing webhooks.

Updated