Skip to main content
The Figranium piece for Activepieces brings Figranium browser automation into Activepieces flows. Use it to execute saved tasks with dynamic inputs, inspect tasks and executions, manage schedules, or call other Figranium API endpoints without building the HTTP requests yourself.

​
Before you start

You need:
  • A running Figranium instance that the Activepieces server can reach.
  • A Figranium API key. See Get Your Figranium API Key.
  • Access to Platform Admin in Activepieces to install the custom piece.

​
Install the piece

1

Open Platform Admin

In Activepieces, open Platform Admin, then select Pieces.
2

Open Install Piece

Click Install Piece.
3

Choose the npm package

Set Package Type to NPM Registry, then enter:
4

Install Figranium

Click Install. After installation, Figranium becomes available in the Activepieces flow builder.
The version field is explicit in Activepieces. When you want to use a newer release of the piece, install the newer published package version.

​
Connect Figranium

Add a Figranium action to a flow and create a connection. The piece authenticates requests to your Figranium instance using the API key.
Dynamic fields such as the Task dropdown are loaded by the Activepieces server. Your Figranium Base URL must therefore be reachable from the Activepieces host, not only from the browser you use to edit the flow.
When Figranium and Activepieces are hosted separately, use the normal URL or network address through which the Activepieces server can reach Figranium. If both services are on a private network, the Base URL can use an internal hostname as long as it resolves from Activepieces.

​
Execute a task

Add the Execute Task action to your flow.
1

Select a task

Choose a saved Figranium task from the Task dropdown. The list is loaded from the connected Figranium instance.
2

Provide variables

Add runtime variable values when the task expects dynamic input. Leave them empty when the saved task does not need overrides.
3

Run the flow

When the Activepieces flow reaches the action, Figranium executes the selected task and returns its result to the flow.
The action executes the task through:

​
Runtime variables

Runtime variables let one saved Figranium task work with different inputs on every Activepieces run. For example, an earlier step can provide a product URL, search query, account identifier, or other value to the browser automation without modifying the task itself. Variable names must match the variables defined by the Figranium task. See Variables & Templating for variable behavior and templating.

​
Actions

  • Execute Task — Run a saved Figranium task with optional runtime variables.
  • List Tasks — Retrieve saved tasks from the connected Figranium instance.
  • List Executions — Retrieve Figranium execution history for use elsewhere in the flow.
  • Schedules — List, inspect, create, update, delete, and describe task schedules.
  • Scheduler Status — Inspect the overall state of the Figranium scheduler.
  • Custom API Call — Call another Figranium API endpoint directly from Activepieces.

​
Schedule actions

Returns tasks that have schedules configured.API call: GET /api/schedules
Returns the schedule configuration and next-run information for a selected task.API call: GET /api/schedules/{taskId}/status
Returns the overall Figranium scheduler status.API call: GET /api/schedules/status/all
Creates or updates the schedule for a selected task.API call: POST /api/schedules/{taskId}
Removes the schedule from a task without deleting the task.API call: DELETE /api/schedules/{taskId}
Validates and previews a schedule configuration without saving it.API call: POST /api/schedules/{taskId}/describe

​
Custom API calls

Use Custom API Call when you need a Figranium endpoint that does not have a dedicated Activepieces action. Choose the HTTP method, provide the endpoint path and any supported request data, then use the returned response in later flow steps. For available endpoints, see the REST API Reference.

​
Networking

The Activepieces server, rather than the flow editor in your browser, communicates with Figranium. A URL that opens successfully on your own computer may not be reachable from Activepieces. For separate hosts, make sure the Activepieces server can resolve and connect to the configured Figranium Base URL and that any firewall, reverse proxy, TLS, or private-network rules permit the connection. If Activepieces runs in a container while Figranium runs directly on the same host, localhost from Activepieces refers to the Activepieces container itself. Use an address that reaches the host from that container. Docker Desktop commonly provides host.docker.internal; other Docker environments may require a host gateway or another reachable host address.

​
Authentication and security

The piece sends your Figranium API key to the Figranium instance configured in the connection. Treat the key as a secret, avoid embedding it directly in flow fields, and rotate it if it is exposed. See API Key for key management instructions.

​
Package

The Figranium Activepieces package is:
Install it through Platform Admin → Pieces → Install Piece → NPM Registry. The package is maintained separately from the built-in Activepieces pieces, so installation is explicit.