Documentation
Support from Community ↗︎

Introduction

Learn more about our Apps framework

Suggest Edits

Developing your own Pipefy app is simple. We built the framework in a way that allows you use intuitive Javascript APIs to build powerful products or integrations on Pipefy’s platform. Display or update external data, add feature buttons to your Pipe, create new tabs on cards, attach data to cards, and open modals or sidebars to display customized views.

The Apps run in iframes in the product, so you can build Apps with any technology you like, including server-side technologies. The framework also gives your Apps access to various product resources by using consistent APIs.

Building your first Pipefy App

Getting Started

Here we will describe how to get started on building Apps. Our framework is intuitive and easy to learn so you’ll be able to quickly pick our sample projects, remix on Glitch, and activate Apps inside your organization.

You will need to be an admin for the Pipefy team where you want to add your App. It doesn't matter whether the team is free or paid. We'll need your App Name and an HTTPS based manifest to get you setup. Click below to get started.

How does it work?

All apps have a manifest.json file that specifies where we will do the initial request and app name, description, etc. This is an example from the appear.in app.

{
  "name": "appear.in",
  "short_description": "Add a persistent video chat link to your pipe in a single click.",
  "description": "No need to create a new video link every time you want to chat with your team. All members in the pipe can access the persistent video chat using the same link at anytime.",
  "icon": "https://cdn.glitch.com/.../icon.png",
  "author": "Pipefy, Inc.",
  "init_url": "./",
  "screenshots": ["https://cdn.glitch.com/.../screenshot.png"],
  "features": [
    "pipe-buttons"
  ]
}

📘

Documentation

Click here to learn more about manifest.json attributes

What happens after manifest.json?

Pipefy will create an iframe calling the init_url specified in the manifest.json, on this page you will include the Pipefy Client JS to interact with framework API and call the initCall from our JS client.

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
  </head>
  <body>
    <!-- Pipefy Apps Client.js -->
    <script src="https://platform.staticpipefy.com/pipefy-app.js"></script>
    <script>
      PipefyApp.initCall({
        // Add pipe buttons
        'pipe-buttons': function(p, pipe) {
          return [
            {
              icon: 'https://cdn.glitch.com/e826a6eb-413f-4073-8b60-51381636ea8d%2Ficon.svg?1504497203271',
              text: 'appear.in',
              url: 'https://appear.in/pipefy-pipe-' + pipe.id,
              target: 'blank'
            }
          ];
        }
      });
    </script>
  </body>
</html>

You can then build the app using any client-side or server-side technology you like. You can build apps using only client-side technologies like HTML, JavaScript, and CSS. You can use Glitch to learn, build and host apps.

Updated 10 months ago

What’s Next