"use client";

// Get the Mintlify search containers, going to reuse them as the triggers for Inkeep
const searchButtonContainerIds = [
  "search-bar-entry",
  "search-bar-entry-mobile",
];

// Clone and replace, needed to remove existing event listeners
const clonedSearchButtonContainers = searchButtonContainerIds.map((id) => {
  const originalElement = document.getElementById(id);
  const clonedElement = originalElement.cloneNode(true);

  originalElement.parentNode.replaceChild(clonedElement, originalElement);

  return clonedElement;
});

// Load the Inkeep script
const inkeepScript = document.createElement("script");
inkeepScript.type = "module";
inkeepScript.src =
  "https://unpkg.com/@inkeep/widgets-embed@0.2.262/dist/embed.js";
document.body.appendChild(inkeepScript);

// Once the Inkeep script has loaded, load the Inkeep chat components
inkeepScript.addEventListener("load", function () {
  // Customization settings
  const sharedConfig = {
    baseSettings: {
      apiKey: "9b77dccb6cacb770614645da24b68c168dc213967b015a6f",
      integrationId: "clt6g42dh0008hl8duk922fjd",
      organizationId: "org_hCC6MgTLBCh3juv4",
      primaryBrandColor: "#8143E3",
    },
    aiChatSettings: {
      chatSubjectName: "Activepieces",
      botAvatarSrcUrl:
        "https://storage.googleapis.com/organization-image-assets/activepieces-botAvatarSrcUrl-1709136841325.svg",
      botAvatarDarkSrcUrl:
        "https://storage.googleapis.com/organization-image-assets/activepieces-botAvatarDarkSrcUrl-1709136840372.svg",
      getHelpCallToActions: [
        {
          name: "Discord",
          url: "https://discord.gg/2jUXBKDdP8",
          icon: {
            builtIn: "FaDiscord",
          },
        },
        {
          name: "Community",
          url: "https://community.activepieces.com/",
          icon: {
            builtIn: "IoPeopleOutline",
          },
        },
        {
          name: "GitHub",
          url: "https://github.com/activepieces/activepieces",
          icon: {
            builtIn: "FaGithub",
          },
        },
      ],
      quickQuestions: [
        "How do I conditionally change a flow?",
        "Can I incorporate custom external APIs?",
        "How do I monitor usage?",
      ],
    },
  };

  // for syncing with dark mode
  const colorModeSettings = {
    observedElement: document.documentElement,
    isDarkModeCallback: (el) => {
      return el.classList.contains("dark");
    },
    colorModeAttribute: "class",
  };

  // add the "Ask AI" pill chat button
  Inkeep().embed({
    componentType: "ChatButton",
    colorModeSync: colorModeSettings,
    properties: sharedConfig,
  });

  // instantiate Inkeep "custom trigger" component
  const inkeepSearchModal = Inkeep({
    ...sharedConfig.baseSettings,
  }).embed({
    componentType: "CustomTrigger",
    colorModeSync: colorModeSettings,
    properties: {
      ...sharedConfig,
      isOpen: false,
      onClose: () => {
        inkeepSearchModal.render({
          isOpen: false,
        });
      },
    },
  });

  // When the Mintlify search bar clone is clicked, open the Inkeep search modal
  clonedSearchButtonContainers.forEach((trigger) => {
    trigger.addEventListener("click", function () {
      inkeepSearchModal.render({
        isOpen: true,
      });
    });
  });
});


Deploy

Develop Pieces

Pieces

Discord

Handbook

Activepieces

Get Started

GitHub

Update Project

apiKey

Your friendliest open source all-in-one automation tool, designed to be extensible.

What is Activepieces?

🥳 Welcome to Activepieces

Product Principles

Overview

Activepieces Handbook

Our Hiring Process

Our Roles & Levels

Our Team Structure

Our Compensation

How We Work?

Pre-Releases

On-Call

Customer Support

Project Schema

Create Project

List Projects

User Invitation Schema

Send a user invitation to a user. If the user already has an invitation, the invitation will be updated.

Send User Invitation (Upsert)

List User Invitations

Delete User Invitation

Project Member Schema

List Project Member

Delete Project Member

Connection Schema

Upsert an app connection based on the app name

Upsert Connection

List Connections

Delete Connection

Flow Schema

Create Flow

Apply Flow Operation

Get Flow

List Flows

Delete Flow

Flow Run Schema

Get Flow Run

List Flows Runs

Piece Schema

Install Piece

Git Repos Schema

Pull all changes from the git repository and overwrite any conflicting changes in the project.

Pull

Folder Schema

Create Folder

Update Folder

Get Folder

List Folders

Delete Folder

Flow Template Schema

Create Flow Template

Delete Flow Template

Get Flow Template

List Flow Templates

Flow consists of two parts, trigger and actions

Building Flows

Using data from previous steps in the current one

Passing Data

Make your flow work by publishing your updates

Publishing Flows

Ensuring your business automations are running properly

Debugging Runs

Learn how flow versioning works in Activepieces

Version History

technical limits for Activepieces execution

Technical limits

Introduction to the different ways to install Activepieces

Single docker image deployment with SQLite3 and Memory Queue

Docker

Docker Compose

Run Activepieces with Easypanel 1-Click Install

Easypanel

Get Activepieces up & running on AWS with Pulumi for IaC

AWS (Pulumi)

Run Activepieces with Elestio 1-Click Install

Elestio

Checklist to follow after deploying Activepieces

Deployment Checklist

Environment Variables

Seperate Workers from App

Setup App Webhooks

Hardware Requirements

Setup HTTPS

Troubleshooting

Workers & Sandboxing

Engine

Stack & Tools

This section helps developers build and contribute pieces.

Start Building

Fork Repository

Getting Started

Local Dev Environment

Dev Containers

GitHub Codespaces

Create Piece Definition

Add Piece Authentication

Create Action

Create Trigger

Learn the different ways to publish your own piece on activepieces.

Learn how to contribute a piece to the main repository.

Contribute

Learn how to publish your piece to the community.

Community (Public NPM)

Learn how to share your pieces privately.

Private

Piece Auth

Periodically call endpoints to check for changes

Polling Trigger

Listen to user events through a single URL

Webhook Trigger

Learn about different types of properties used in triggers / actions

Props

Learn about different types of properties validation 

Props Validation

Learn How to Control Flow from Inside the Piece

Flow Control

Learn how to store and retrieve data from a key-value store

Persistent Storage

Learn how to use files object to create file references.

Files

Learn how to install and use external libraries.

External Libraries

Piece Versioning

Explore a collection of example triggers and actions

Piece Examples

Learn how to enable custom API calls for your pieces

Enable Custom API Calls

The AI Toolkit to build AI pieces tailored for specific use cases that work with many AI providers

Learn how to use chat completion AI in actions

Chat Completion

Learn how to use function calling AI in actions

Function Calling

Image AI

Build Custom Pieces

Publish Custom Pieces

Custom Pieces CI/CD

Create New AI Provider

Setup Private Fork

Automatically authenticate your SaaS users to your Activepieces instance

Provision Users

Embed Builder

Navigation

Customize Pieces

Create Connections

A log of all notable changes to Activepieces SDK

SDK Changelog

Appearance

Managed Projects

Custom Domains

Manage Templates

Manage Pieces

Replace OAuth2 Apps

Customize Emails

Manage AI Providers

Environments & Git Sync

Flow Created

Flow Updated

Flow Deleted

Connection Upserted

Connection Deleted

Flow Run Started

Flow Run Finished

Folder Created

Folder Updated

Folder Deleted

User Signed In

User Signed Up

User Email Verified

User Password Reset

Signing Key Created

We prioritize security and follow these practices to keep information safe.

Security & Data Practices

Documentation on project permissions in Activepieces

Project Permissions

Single Sign-On

i18n Translations

Editions

This list shows all versions that include breaking changes and how to upgrade.

Breaking Changes

A log of all notable changes to Activepieces

Get Started

Endpoints

Update Project

Authorizations

Path Parameters

Body

Response