Skip to main content

​
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.

​
Requirements

To generate an n8n API key, follow the instructions here.

​
Permissions

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.
On an enterprise instance, grant the key these scopes and nothing else: 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.
Granting <resource>:read automatically grants the matching list scope, so there is no need to add workflow:list or execution:list explicitly.

​
What Cymph reads and writes

​
Testing the connection