Integrations
Zapier
Actions

Zapier Actions

Actions are things you can do in Canvelete (opens in a new tab) from your Zapier workflows. These allow you to create designs, render images, manage API keys, and more as part of your automated processes.

Available Actions

Create Design

Action Key: create_design

Creates a new design in your Canvelete account with the specified properties.

Input Fields

FieldTypeRequiredDescription
nameStringYesName for the new design
descriptionStringNoDescription of the design
canvasDataStringNoJSON string containing canvas elements
widthNumberNoDesign width in pixels (default: 1920)
heightNumberNoDesign height in pixels (default: 1080)
isTemplateBooleanNoMark as template (default: false)
visibilityStringNoVisibility setting (default: PRIVATE)

Visibility Options

  • PRIVATE: Only visible to you
  • PUBLIC: Visible to everyone
  • UNLISTED: Accessible via direct link only

Canvas Data Format

The canvasData field accepts a JSON string representing the design elements:

{
  "elements": [
    {
      "type": "text",
      "content": "Hello World",
      "x": 100,
      "y": 100,
      "fontSize": 24,
      "fontFamily": "Arial",
      "color": "#000000"
    },
    {
      "type": "rectangle",
      "x": 50,
      "y": 50,
      "width": 200,
      "height": 100,
      "fill": "#FF7A00"
    }
  ]
}

Output Fields

FieldTypeDescription
idStringUnique identifier for the created design
nameStringName of the design
descriptionStringDesign description
widthNumberDesign width in pixels
heightNumberDesign height in pixels
statusStringDesign status (always "DRAFT" for new designs)
visibilityStringVisibility setting
isTemplateBooleanWhether marked as template
thumbnailUrlStringURL to generated thumbnail
editUrlStringURL to edit the design in Canvelete
createdAtStringISO timestamp of creation

Common Use Cases

  • Form to Design: Convert form submissions into design briefs
  • Bulk Design Creation: Generate multiple designs from spreadsheet data
  • Template Instantiation: Create designs from predefined templates
  • Dynamic Content: Generate designs with data from other apps

Render Design

Action Key: render_design

Renders a design or template to an image or PDF file.

Input Fields

FieldTypeRequiredDescription
designIdStringNo*ID of design to render
templateIdStringNo*ID of template to render
dynamicDataStringNoJSON string with dynamic data
formatStringNoOutput format (default: png)
widthNumberNoCustom width in pixels
heightNumberNoCustom height in pixels
qualityNumberNoQuality for JPG (1-100, default: 90)

*Either designId or templateId is required.

Format Options

  • png: PNG image (supports transparency)
  • jpg / jpeg: JPEG image (smaller file size)
  • pdf: PDF document (vector-based, scalable)

Dynamic Data Format

For templates with dynamic elements, provide data as JSON:

{
  "title": "Welcome to Our Store",
  "subtitle": "Special Offer Inside",
  "price": "$29.99",
  "image_url": "https://example.com/product.jpg"
}

Output Fields

FieldTypeDescription
idStringUnique identifier for the render job
formatStringOutput format used
widthNumberRendered image width
heightNumberRendered image height
fileSizeNumberFile size in bytes
downloadUrlStringTemporary download URL (expires in 24h)
statusStringRender status (COMPLETED/FAILED)
processingTimeNumberRender time in milliseconds
messageStringSuccess or error message

Common Use Cases

  • Social Media Automation: Generate posts with dynamic content
  • Email Marketing: Create personalized images for campaigns
  • E-commerce: Generate product images with pricing updates
  • Reports: Create visual reports from data

Create API Key

Action Key: create_api_key

Creates a new API key for programmatic access to Canvelete.

Input Fields

FieldTypeRequiredDescription
nameStringYesName for the API key
descriptionStringNoDescription of intended use
scopesStringNoComma-separated list of scopes
expiresAtStringNoISO date when key expires

Available Scopes

  • designs:read: Read access to designs
  • designs:write: Create and modify designs
  • templates:read: Read access to templates
  • render:write: Generate renders
  • apikeys:read: View API keys
  • apikeys:write: Manage API keys

Output Fields

FieldTypeDescription
idStringUnique identifier for the API key
nameStringName of the API key
keyStringThe actual API key (store securely!)
scopesArrayArray of granted scopes
expiresAtStringExpiration date (if set)
createdAtStringCreation timestamp

⚠️ Important: The API key is only shown once. Store it securely immediately.

Common Use Cases

  • Integration Setup: Create keys for new integrations
  • Team Management: Generate keys for team members
  • Temporary Access: Create time-limited keys for contractors
  • Service Accounts: Generate keys for automated systems

Search Actions

Search actions help you find existing data in Canvelete to use in your workflows.

Find Design

Action Key: find_design

Searches for designs by name or ID.

Input Fields

FieldTypeRequiredDescription
queryStringYesSearch term (name or ID)
visibilityStringNoFilter by visibility
isTemplateBooleanNoFilter templates only

Output Fields

Returns the same fields as the "New Design" trigger for matching designs.

Find Template

Action Key: find_template

Searches for templates by name or ID.

Input Fields

FieldTypeRequiredDescription
queryStringYesSearch term (name or ID)
categoryStringNoFilter by template category

List API Keys

Action Key: list_api_keys

Retrieves a list of your API keys.

Input Fields

FieldTypeRequiredDescription
includeExpiredBooleanNoInclude expired keys (default: false)

Action Configuration

Error Handling

All actions include built-in error handling:

  • Authentication Errors: Automatically handled with token refresh
  • Validation Errors: Clear error messages for invalid input
  • Rate Limiting: Automatic retry with exponential backoff
  • Server Errors: Detailed error information for troubleshooting

Rate Limits

Actions are subject to API rate limits:

  • Free Plan: 100 requests per hour
  • Starter Plan: 500 requests per hour
  • Professional Plan: 2,000 requests per hour
  • Team Plan: 5,000 requests per hour
  • Company Plan: 10,000 requests per hour

Data Validation

Input data is validated before processing:

  • Required Fields: Must be provided and non-empty
  • Data Types: Must match expected types (string, number, boolean)
  • Formats: JSON strings must be valid JSON
  • Limits: Text fields have maximum length limits

Best Practices

Performance

  1. Batch Operations: Use bulk actions when available
  2. Caching: Cache frequently used template/design IDs
  3. Async Processing: Use webhooks for long-running operations

Security

  1. API Keys: Store API keys securely, rotate regularly
  2. Scopes: Use minimal required scopes for API keys
  3. Expiration: Set expiration dates for temporary keys

Data Management

  1. Naming: Use descriptive names for designs and API keys
  2. Organization: Use consistent naming conventions
  3. Cleanup: Remove unused designs and expired API keys

Error Recovery

  1. Validation: Validate input data before sending to actions
  2. Retries: Implement retry logic for transient failures
  3. Fallbacks: Have fallback workflows for critical processes

Advanced Usage

Dynamic Field Population

Use Zapier's dynamic field features:

// Populate design dropdown from trigger
designId: {{trigger.id}}
 
// Use previous step data
name: "Design for {{trigger.customer_name}}"
 
// Conditional logic
visibility: {{trigger.is_public ? "PUBLIC" : "PRIVATE"}}

Multi-Step Workflows

Combine actions for complex workflows:

  1. Create Design → Get design ID
  2. Render Design → Generate image
  3. Upload to Cloud → Store permanently
  4. Send Notification → Inform stakeholders

Template-Based Workflows

For dynamic content generation:

  1. Find Template → Get template ID
  2. Render Design → Apply dynamic data
  3. Post to Social → Share generated content

Troubleshooting

Common Issues

Action Fails with Authentication Error

  • Check if your Canvelete connection is still active
  • Reconnect your account if needed
  • Verify you have necessary permissions

Invalid Canvas Data

  • Ensure JSON is properly formatted
  • Validate element properties match expected schema
  • Test with simple elements first

Render Timeouts

  • Complex designs may take longer to render
  • Consider simplifying design elements
  • Use appropriate image dimensions

For more help, see our troubleshooting guide.

Next Steps