Integrations
n8n
Installation

n8n Installation

Learn how to install and set up the Canvelete (opens in a new tab) n8n community node to automate your design workflows with n8n's powerful automation platform.

Overview

The Canvelete n8n node allows you to integrate Canvelete's design and rendering capabilities directly into your n8n workflows. You can create designs, render images and PDFs, manage templates, and handle API keys programmatically.

Prerequisites

Before installing the Canvelete n8n node, ensure you have:

Installation Methods

Method 1: Community Node Installation (Recommended)

This is the easiest method for most users.

For n8n Cloud Users

  1. Access Community Nodes

    • Log into your n8n cloud instance
    • Navigate to Settings → Community Nodes
    • Click Install a community node

  2. Install the Package

    • Enter n8n-nodes-canvelete in the npm Package Name field
    • Click Install
    • Wait for the installation to complete

  3. Verify Installation

    • Go to your workflow editor
    • Search for "Canvelete" in the node search
    • You should see the Canvelete node with the orange logo

For Self-Hosted n8n

  1. Enable Community Nodes

    • Ensure community nodes are enabled in your n8n configuration
    • Set N8N_COMMUNITY_PACKAGES_ENABLED=true in your environment

  2. Install via UI

    • Access your n8n instance
    • Go to Settings → Community Nodes
    • Click Install a community node
    • Enter n8n-nodes-canvelete
    • Click Install

  3. Alternative: Command Line Installation

    # Navigate to your n8n installation directory
cd ~/.n8n
 
# Install the community node
npm install n8n-nodes-canvelete
 
# Restart n8n
n8n start

Method 2: Manual Installation (Development)

Use this method if you're developing or customizing the node.

Clone and Build

# Clone the repository
git clone https://github.com/amanuel-1/canvelete.git
cd canvelete/n8n-nodes-canvelete
 
# Install dependencies
npm install
 
# Build the node
npm run build

Link to n8n

# In the node directory
npm link
 
# In your n8n installation directory
cd ~/.n8n
npm link n8n-nodes-canvelete
 
# Restart n8n
n8n start

OAuth2 Setup

The Canvelete n8n node uses OAuth2 for secure authentication.

Step 1: Obtain OAuth2 Credentials

  1. Contact Canvelete Support

    • Email: support@canvelete.com
    • Request: OAuth2 credentials for n8n integration
    • Provide: Your n8n instance URL

  2. Receive Credentials

    • Client ID: n8n-canvelete
    • Client Secret: (provided securely)
    • Redirect URI: Your n8n callback URL

Step 2: Configure Credentials in n8n

  1. Create New Credential

    • In n8n, go to Credentials
    • Click Add Credential
    • Search for "Canvelete OAuth2 API"
    • Select the credential type

  2. Enter OAuth2 Details

    • Authorization URL: https://canvelete.com/api/oauth/authorize
    • Access Token URL: https://canvelete.com/api/oauth/token
    • Client ID: n8n-canvelete
    • Client Secret: (provided by Canvelete)
    • Scope: openid profile email designs:read designs:write templates:read apikeys:read apikeys:write render:write

  3. Authorize Connection

    • Click Connect my account
    • You'll be redirected to Canvelete
    • Log in with your Canvelete credentials
    • Authorize the requested permissions
    • You'll be redirected back to n8n

  4. Verify Connection

    • The credential should show as "Connected"
    • Your Canvelete email will be displayed as the connection label

Verification

Test the Installation

Create a simple test workflow to verify everything works:

  1. Create New Workflow

    • Click New Workflow in n8n
    • Add a Manual Trigger node

  2. Add Canvelete Node

    • Search for "Canvelete" in the node list
    • Add the Canvelete node to your workflow
    • Connect it to the Manual Trigger

  3. Configure Test Operation

    • Resource: Design
    • Operation: Get Many
    • Credential: Select your Canvelete OAuth2 credential
    • Limit: 5

  4. Execute Test

    • Click Execute Workflow
    • The node should return a list of your designs
    • Check the output data to verify it's working

Troubleshooting Installation

Node Not Found

Problem: Canvelete node doesn't appear in the node list.

Solutions:

  • Restart n8n after installation
  • Clear n8n cache: rm -rf ~/.n8n/cache
  • Verify community nodes are enabled
  • Check installation logs for errors

OAuth2 Connection Fails

Problem: Authentication fails during credential setup.

Solutions:

  • Verify OAuth2 URLs are correct
  • Check client ID and secret with Canvelete support
  • Ensure redirect URI matches your n8n instance
  • Check browser console for CORS errors

Permission Denied Errors

Problem: Operations fail with permission errors.

Solutions:

  • Verify all required scopes are granted
  • Re-authorize the connection
  • Check your Canvelete account permissions
  • Contact support if scopes are missing

Available Resources and Operations

Once installed, the Canvelete node provides these resources:

Design Operations

  • Create: Create new designs with custom dimensions
  • Get: Retrieve specific designs by ID
  • Get Many: List all your designs
  • Search: Search designs by name

Render Operations

  • Create: Generate PNG, JPG, or PDF from designs/templates
  • Get Many: View render history

Template Operations

  • Get Many: Browse available templates
  • Search: Find templates by name or description

API Key Operations

  • Create: Generate new API keys
  • Get Many: List existing API keys

Configuration Options

Environment Variables (Self-Hosted)

For self-hosted n8n installations, you can configure:

# Enable community packages
N8N_COMMUNITY_PACKAGES_ENABLED=true
 
# Custom package directory (optional)
N8N_CUSTOM_EXTENSIONS=~/.n8n/custom
 
# OAuth2 settings (if customizing)
CANVELETE_OAUTH_CLIENT_ID=n8n-canvelete
CANVELETE_OAUTH_BASE_URL=https://canvelete.com

Node Configuration

Each Canvelete node can be configured with:

  • Credential: Your OAuth2 connection
  • Resource: Type of operation (Design, Render, Template, API Key)
  • Operation: Specific action to perform
  • Parameters: Operation-specific settings

Security Considerations

OAuth2 Security

  • Secure Storage: Credentials are encrypted by n8n
  • Token Refresh: Access tokens are automatically refreshed
  • Scope Limitation: Only request necessary permissions
  • Revocation: Tokens can be revoked from Canvelete dashboard

Best Practices

  1. Credential Management

    • Use separate credentials for different environments
    • Regularly rotate OAuth2 client secrets
    • Monitor credential usage in n8n logs

  2. Access Control

    • Limit workflow access to authorized users
    • Use n8n's user management features
    • Audit workflow executions regularly

  3. Data Handling

    • Be mindful of sensitive data in workflows
    • Use n8n's data encryption features
    • Implement proper error handling

Next Steps

Now that you have the Canvelete n8n node installed:

  1. Learn Configuration: Read the Configuration Guide
  2. Explore Workflows: Check out Workflow Examples
  3. Custom Development: Learn about Custom Nodes
  4. Get Support: Join the community or contact support

Support Resources

Documentation

Community

Direct Support

TroubleshootingConfiguration