> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cymph.io/llms.txt
> Use this file to discover all available pages before exploring further.

# n8n

> Deploy playbooks to an n8n instance as workflows.

## What Cymph uses it for

Cymph connects to n8n as a deployment target — playbooks authored in Cymph are translated to n8n workflows and pushed to the instance. See [Deploy playbooks](/how-tos/deploy-playbooks).

## Requirements

| Field | Description |
| - | - |
| **Instance URL** | The URL of your n8n instance |
| **API key** | An n8n API key |

To generate an n8n API key, follow the instructions [here](https://docs.n8n.io/api/authentication/).

## Permissions

<Warning>
  API key **scopes are an enterprise feature**. On a non-enterprise instance, every API key has full access to all of the account's resources — there is no way to narrow it. Treat the key as an administrative credential and store it accordingly.
</Warning>

On an enterprise instance, grant the key these scopes and nothing else:

| Scope | Why Cymph needs it |
| - | - |
| `workflow:read` | Read workflows — also grants `workflow:list` |
| `workflow:create` | Create a workflow when a playbook is deployed |
| `execution:read` | Read execution history — also grants `execution:list` |
| `user:list` | Resolve workflow owners to names |

Cymph does not need `workflow:update`, `workflow:delete`, `workflow:activate`, or any credential scope. Deployed workflows are created, never modified or removed, and Cymph never reads your stored credentials.

<Tip>
  Granting `<resource>:read` automatically grants the matching `list` scope, so there is no need to add `workflow:list` or `execution:list` explicitly.
</Tip>

## What Cymph reads and writes

## Testing the connection


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.