Skip to main content
The n8n integration is in beta. It supports n8n’s public REST API for workflows, executions, credentials, users, projects, tags, variables, and data tables. Available operations depend on your n8n version, plan, and API key permissions. Importing and exporting n8n packages is not supported because those endpoints require multipart uploads or return binary archives.

​
Connect n8n

  1. In n8n, open Settings > n8n API and create an API key.
  2. On Enterprise plans, grant workflow:list for the connection check and only the additional scopes your automations need. Non-Enterprise keys have full access to the account’s resources and capabilities.
  3. In Serval, open Settings > Integrations and select n8n.
  4. Enter your API URL, including HTTPS and the /api/v1 suffix:
    • Cloud: https://your-instance.app.n8n.cloud/api/v1
    • Self-hosted: https://automation.example.com/api/v1
    • With a subpath: https://automation.example.com/n8n/api/v1
  5. Enter your API Key and save.
Serval stores the key as a secret and adds it to API requests. Workflow code receives the connection ID and API location. Changing the API URL requires entering a new key. For an instance on a private network, enable Run on self-hosted workers. The worker must be able to reach the instance and trust its TLS certificate.

​
Verify the connection

The connection check reads one workflow. Additional healthchecks read one execution and one tag, requiring execution:list and tag:list respectively. These checks do not modify resources or return workflow or execution contents. If a check fails, verify the URL, key expiration, and required scope. n8n’s public API is unavailable during a free trial. An operation may also require a newer n8n version or an Enterprise plan. List responses include nextCursor when another page is available. Pass it as cursor on the next request; the SDK returns each page separately. See the n8n API documentation for operation details and permissions.