"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,
      });
    });
  });
});


Prerequisites

Instructions

Deploy

Develop Pieces

Discord

Pieces

Handbook

Activepieces

Get Started

GitHub

Local Dev Environment

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

What is Activepieces?

🥳 Welcome to Activepieces

Product Principles

Overview

Project Schema

Create Project

Update Project

List Projects

Project Member Schema

Create Project Member

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

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

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

Environment Variables

Flow Runs Error Webhook

Setup Webhook Secrets

Setup HTTPS

Architecture

Switch to Enterprise Edition

Troubleshooting

This section to help you build pieces & contribute

Start Building

Fork Repository

Getting Started

Dev Containers

GitHub Codespaces

Piece Definition

Piece Authentication

Create Action

Create Trigger

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

Learn how to contribute piece to main repository.

Contribute

Learn how to publish your piece to the community.

Community

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

Repository Structure

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

Environments & Git Sync

Audit Log

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

Security & Data Practices

Project Permissions

Single Sign-On

i18n Translations

Editions

A log of all notable changes to Activepieces

Getting Started

Build a Piece

Piece Reference

Architecture

Local Dev Environment

Prerequisites

Instructions

Getting Started

Build a Piece

Piece Reference

Architecture

​Prerequisites

​Instructions

Prerequisites

Instructions