Activepieces Platform
The Activepieces Platform piece in ZBrain Flow provides integration with Activepieces' own automation platform, allowing you to manage projects and resources directly from your workflows. This powerful connector enables you to create, update, and access Activepieces projects without manual intervention. With Activepieces Platform integration, you can build automations that provision new automation projects, update existing configurations, list available resources, and interact with the Activepieces API programmatically. This piece is ideal for platform administrators looking to automate the management of their Activepieces environment, implement dynamic project provisioning, and maintain consistent configuration across multiple automation projects.
How to Use the Activepieces Platform in ZBrain Flow?
Select Activepieces Platform as Your Connection
Click on the '+' button in the Flow and search for Activepieces Platform.
Select Activepieces Platform.
Decide on the action you need, then select it. ZBrain Flow provides several options:
Create Project – Set up new projects in your Activepieces environment.
Update Project – Modify configuration details of existing projects.
List Projects – View all available projects in your Activepieces account.
Custom API Call – Make specialized requests to the Activepieces API.
How to Connect to the Activepieces Platform
Before using any Activepieces Platform actions in ZBrain Flow, you'll need to set up a connection to your Activepieces instance. This is a one-time setup that will allow you to access and manage your automation environment securely.
To create your Activepieces Platform connection:
From any Activepieces Platform action, click on the connection dropdown and select 'Create connection'.
In the pop-up window that appears, you'll need to:
Enter a descriptive 'Connection Name' to identify this Activepieces connection
In the 'Base URL' field, enter the URL of your Activepieces Platform instance
In the 'API Key' field, enter your Activepieces Platform API key
Click 'Save' to store this connection
To obtain your Activepieces Platform credentials:
You must have the Platform Edition of Activepieces
Log in to your Activepieces Platform Dashboard
Navigate to the API Keys section
Generate or copy your existing API key
How to Create a New Project in Activepieces
Configuration Steps:
Connect to your Activepieces Platform following the steps in the "How to Connect to the Activepieces Platform" section.
In the 'Display Name' field, enter a name for your new project. This name will be visible in the Activepieces dashboard and used to identify the project.
How to Modify Existing Automation Projects
Configuration Steps:
Connect to your Activepieces Platform following the steps in the "How to Connect to the Activepieces Platform" section.
In the 'Id' field, enter the unique identifier of the project you want to modify. This ID can be obtained from a previous Create Project action or from the Activepieces Platform dashboard.
In the 'Display Name' field, enter the new name for the project.
From the 'Notify Status' dropdown, select the notification preference for this project. This controls when and how users are notified about project activities.
In the 'Tasks' field, optionally specify the maximum number of tasks allowed for this project.
In the 'Team Members' field, optionally enter the list of users who should have access to this project.
How to List Projects in Activepieces
To list projects, you simply need to connect to your Activepieces Platform following the steps in the "How to Connect to the Activepieces Platform" section.
How to Make a Custom API Call
Configuration Steps:
Connect to your Activepieces Platform following the steps in the "How to Connect to the Activepieces Platform" section.
From the 'Method' dropdown, select the appropriate HTTP method (GET, POST, PUT, DELETE) for your API request.
In the 'Headers' section, click 'Add Item' to add any custom headers needed for your request. Note that authorization headers are automatically injected from your connection.
In the 'Query Parameters' section, click 'Add Item' to add any URL parameters required.
In the 'Body' field, enter the JSON data to send in your request for POST or PUT methods.
Optionally enable 'No Error on Failure' if you want the flow to continue even if the API request fails.
Optionally set a 'Timeout' value in seconds to limit how long to wait for a response.
Last updated