ExplorePricingDocsCommunityBlogCareers
  Star
Sign InSign Up Free!
← Pipefy

Create Pipe with Pipefy API

Pipedream makes it easy to connect APIs for Pipefy and 1000+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Pipe with the Pipefy API
No credit card required
Into to Pipedream
▶
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started

Create a workflow to Create Pipe with the Pipefy API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Create Pipe action
    1. Connect your Pipefy account
    2. Select a Organization
    3. Configure Name
    4. Configure Phase Names
    5. Optional- Select one or more Members
    6. Optional- Select a Icon
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create Pipe with Pipefy API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Pipefy
 
Try it
Create Pipe with Pipefy API on New Item in Feed from RSS API
RSS + Pipefy
 
Try it
Create Pipe with Pipefy API on New Message from Discord API
Discord + Pipefy
 
Try it
Create Pipe with Pipefy API on New Message In Channels from Slack API
Slack + Pipefy
 
Try it
Create Pipe with Pipefy API on New Message in Channel from Discord Bot API
Discord Bot + Pipefy
 
Try it

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Create Pipe on Pipefy
Description:Creates a pipe. [See the docs here](https://api-docs.pipefy.com/reference/mutations/createPipe/)
Version:0.3.2
Key:pipefy-create-pipe

Code

import pipefy from "../../pipefy.app.mjs";
import constants from "../common/constants.mjs";

export default {
  key: "pipefy-create-pipe",
  name: "Create Pipe",
  description: "Creates a pipe. [See the docs here](https://api-docs.pipefy.com/reference/mutations/createPipe/)",
  version: "0.3.2",
  type: "action",
  props: {
    pipefy,
    organization: {
      propDefinition: [
        pipefy,
        "organization",
      ],
    },
    name: {
      type: "string",
      label: "Name",
      description: "Name of the new Pipe",
    },
    phases: {
      type: "string[]",
      label: "Phase Names",
      description: "Names of the new Pipe's phases",
      reloadProps: true,
    },
    members: {
      propDefinition: [
        pipefy,
        "members",
        (c) => ({
          orgId: c.organization,
        }),
      ],
      withLabel: true,
      reloadProps: true,
    },
    icon: {
      type: "string",
      label: "Icon",
      description: "The Pipe icon",
      options: constants.ICON_OPTIONS,
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.phases?.length > 0) {
      for (const phase of this.phases) {
        props[phase] = {
          type: "boolean",
          label: `${phase} Done?`,
          description: `Is ${phase} a final/done phase?`,
          default: false,
        };
      }
    }
    if (this.members?.length > 0) {
      for (const member of this.members) {
        props[member.value] = {
          type: "string",
          label: `Role for ${member.label}`,
          description: "The user role name",
          options: constants.ROLE_OPTIONS,
        };
      }
    }
    return props;
  },
  async run({ $ }) {
  /*
  Example query:

  mutation createNewPipe{
    createPipe(
        input: {name: "UsersPipe", organization_id: 300455771 } ) {
            pipe{id name}
      }
  }
  */

    const variables = {
      name: this.name,
      organizationId: this.organization,
      icon: this.icon,
    };

    if (this.phases?.length > 0) {
      const phases = [];
      for (const phase of this.phases) {
        phases.push({
          name: phase,
          done: this[phase],
        });
      }
      variables.phases = phases;
    }

    if (this.members?.length > 0) {
      const members = [];
      for (const member of this.members) {
        members.push({
          role_name: this[member.value],
          user_id: member.value,
        });
      }
      variables.members = members;
    }

    const response = await this.pipefy.createPipe(variables);
    $.export("$summary", "Successfully created pipe");
    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
PipefypipefyappThis component uses the Pipefy app.
OrganizationorganizationstringSelect a value from the drop down menu.
Namenamestring

Name of the new Pipe

Phase Namesphasesstring[]

Names of the new Pipe's phases

Membersmembersstring[]Select a value from the drop down menu.
IconiconstringSelect a value from the drop down menu:airplaneataxebadgebagboatbriefingbugbullhorncalendarcartcatchart-zoomchart2chatcheckchecklistcompasscontractdogeiffelemofinish-flagflameframefroggamegithubglobegrowthhr-processhr-requestsicejuicelamplemonadelibertylikemacmagicmapmessagemkt-requestsmoneyonboardingpacmanpacman1payablephonepipefypizzaplanetplugreceivablesreceiverecruitment-requestsreloadrocketsalesskullsnow-flakestartargettasktask-managementtrophyunderwear

Authentication

Pipefy uses API keys for authentication. When you connect your Pipefy account, Pipedream securely stores the keys so you can easily authenticate to Pipefy APIs in both code and no-code steps.

To authorize requests to the Pipefy API, you'll need to generate a Personal access token. In order to create Pipefy triggers in Pipedream, you will need to be a Pipefy administrator.

About Pipefy

Process Management, Workflow Management Software

More Ways to Use Pipefy

Triggers

Card Created (Instant) from the Pipefy API

Emits an event for each new card created in a Pipe.

 
Try it
Card Done (Instant) from the Pipefy API

Emits an event each time a card is moved to Done a Pipe.

 
Try it
Card Expired from the Pipefy API

Emits an event each time a card becomes expired in a Pipe.

 
Try it
Card Field Updated (Instant) from the Pipefy API

Emits an event each time a card field is updated in a Pipe.

 
Try it
Card Late from the Pipefy API

Emits an event each time a card becomes late in a Pipe.

 
Try it

Actions

Create Card with the Pipefy API

Create a new Card in a Pipe. See the docs here

 
Try it
Create Table Record with the Pipefy API

Creates a new table record. See the docs here

 
Try it
Delete Card with the Pipefy API

Deletes a card. See the docs here

 
Try it
Get All Cards with the Pipefy API

Fetches all cards in a pipe. See the docs here

 
Try it
Get Current User with the Pipefy API

Gets information of the current authenticated user. See the docs here

 
Try it

Explore Other Apps

1
-
12
of
1000+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.
Data Stores
Data Stores
Use Pipedream Data Stores to manage state throughout your workflows.
Google Sheets
Google Sheets
With Google Sheets, you can create, edit, and collaborate wherever you are
Airtable
Airtable
Looks like a spreadsheet, acts like a database.
Telegram Bot
Telegram Bot
Telegram is a cloud-based instant messaging and voice over IP service
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Go
Go
Anything you can do in Go, you can do in a Pipedream Workflow. You can use any of Go packages available with a simple import.
GitHub
GitHub
Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.
Google Drive
Google Drive
Internet-related services and products
Pipedream, Inc. — San Francisco, CA
AboutTwitterDocsCommunityTermsPrivacy