Activepieces

Welcome to the Activepieces Integration Guide! Using our native piece, you can effortlessly link cloud applications, databases, and forms directly to your ComposeIt document rendering engines to automate document design without writing code.

Setup & Configuration

Step 1: Locate the Piece

If you are running a self-hosted instance of Activepieces and the piece is not yet visible in your global directory, you can register it instantly by the npm module:

@composeit/activepieces

Once installed, open your workflow canvas, append a new action block to your trigger, and filter for ComposeIt.

Step 2: Establish API Connection

Click on the added ComposeIt step to reveal its properties panel. Under the Connection field, click Add. Input a recognizable name for your credential account and insert your ComposeIt API Key into the token field to authorize communications.

Action 1: Update Template

This block allows you to tweak template parameters programmatically during automated tasks.

1. Pick your desired design matrix from the Template dropdown menu.
2. Provide your new parameters.
3. Test the step to confirm modifications successfully synchronized.

Action 2: Generate Document

This block automates document compilation by joining dynamic workflow variables into your structured visual template profiles.

1. Choose Target Formats

Decide which asset outputs your automation process expects. Depending on the design matrix you are working with, you can choose:

• PDF: Optimized document rendering for client distribution.
• Image: Visual layouts captured cleanly as flat pictures.
• HTML / MJML: Ready-to-send transactional payload codes.

2. Map Dynamic Variables

You can input values into individual input boxes parsed directly from your template's data configuration schema. If you are dealing with relational rows or deep array loops (like line-item arrays), switch the interface to JSON Mode to provide a direct JSON payload.

1. Raw JSON	2. Field Mapping

3. Test Generation & Secure Files

Click Test Step to send a live mock request. Activepieces will process the layout and return a temporary file URL containing your generated document.

💡 Don't forget: Immediately add a Google Drive, Dropbox, or email step right after this action to save your generated PDF file before the 24-hour retention window closes!