Pipefy

Pipefy
Prev	Productivity	Next

Getting Started with Pipefy

The Pipefy modules allow you to monitor new, moved, done, overdue, late, and expired cards or create, update, list, or delete cards and tables in your Pipefy account.

Prerequisites

A Pipefy account

In order to use Pipefy with {{Make}}, it is necessary to have a Pipefy account. If you do not have one, you can create a Pipefy account at app.pipefy.com/registrations/new.

Connecting Pipefy to {{Make}}

To connect your Pipefy account to {{Make}} you need to obtain the API Key from your Pipefy account and insert it into the {{Make}} module.

Log in to your Pipefy account.
Click Your Profile Icon > Account Preferences > Personal Access Tokens > Generate a new token.
Enter a name for the token and click Save.
Copy the API token to your clipboard and click Save.
Log in to your {{Make}} account, add a Pipefy module scenario, and click Add next to the Connection field.
In the Connection name field, enter a name for the connection.
In the API Key field, enter the token copied in step 4.
Optional: In the Subdomain field, enter your account domain details. For example, if your full domain is bestsaas.pipefy.com then your subdomain is bestsaas.
Click Save.

Triggers

	Note
Sometimes it may take a few minutes until the webhook is triggered. Unfortunately, {{Make}} can't do anything about it. These delays are caused by Pipefy servers. {{Make}} automatically creates a webhook in Pipefy once you add an instant trigger to your scenario.

Note

Sometimes it may take a few minutes until the webhook is triggered. Unfortunately, {{Make}} can't do anything about it. These delays are caused by Pipefy servers.

{{Make}} automatically creates a webhook in Pipefy once you add an instant trigger to your scenario.

Watch New Cards

Triggers when a new card is created.

Webhook name	Enter a name for the webhook.
Connection	Establish a connection to your Pipefy account.
Organization	Select or map the organization whose new cards you want to watch.
Pipe ID	Select or map the Pipe ID whose new cards you want to watch.

Watch Moved Cards

Triggers when a card is moved in a selected pipe.

Webhook name	Enter a name for the webhook.
Connection	Establish a connection to your Pipefy account.
Organization	Select or map the organization whose moved cards you want to watch.
Pipe ID	Select or map the Pipe ID whose moved cards you want to watch.

Watch Done Cards

Triggers when a card is moved into the Done phase.

Webhook name	Enter a name for the webhook.
Connection	Establish a connection to your Pipefy account.
Organization	Select or map the organization whose done cards you want to watch.
Pipe ID	Select or map the Pipe ID whose done cards you want to watch.

Watch Overdue Cards

Triggers when a card's overdue date and time are passed.

Webhook name	Enter a name for the webhook.
Connection	Establish a connection to your Pipefy account.
Organization	Select or map the organization whose overdue cards you want to watch.
Pipe ID	Select or map the Pipe ID that you want to monitor for cards that passed the overdue date and time.

Watch Late Card

Triggers when a card remains in the phase longer than specified in the late alert setting.

Webhook name	Enter a name for the webhook.
Connection	Establish a connection to your Pipefy account.
Organization	Select or map the organization whose late cards you want to watch.
Pipe ID	Select or map the Pipe ID that you want to monitor for cards that are late.

Watch Expired Cards

Triggers when a card remains in the pipe longer than specified in the Pipe settings.

Webhook name	Enter a name for the webhook.
Connection	Establish a connection to your Pipefy account.
Organization	Select or map the organization whose expired cards you want to watch.
Pipe ID	Select or map the Pipe ID that you want to monitor for expired cards.

Watch Card Field Update

Trigger when a card field is updated.

Webhook	Enter a name for the webhook.
Connection	Establish a connection to your Pipefy account.
Organization	Select or map the organization whose updated card fields you want to watch.
Pipe ID	Select or map the Pipe ID whose updated card fields you want to watch.

Pipes

You can create, update, list, retrieve, and delete cards, move cards to phase, retrieve phases, and update card fields.

Create a Card

Creates a new card in a selected pipe.

Connection	Establish a connection to your Pipefy account.
Pipe ID	Select the pipe you want to create a new card in.
Main Fields	Add fields for the card you want to create. The value of the entered field must be in the respective format. Available field types. For example, when the `Due Date` type field is selected, the value must be in `DD/MM/YYYY HH:MM`.
Additional fields	Use this for additional custom fields. You can use this, for example, for adding the checkbox field type, as described below.
Assignees	Enter the users assigned to this card.

	Caution
	{{Make}} is unable to recognize a custom field type. E.g. if you want to add a checkbox with one of the options selected, it is necessary to use the following workaround.

Creating Card with Additional Field

Example

A card that contains a checkbox with the second option selected.

In order to create a card that contains the checkbox field type, it is necessary to use JSON > Parse JSON module.

1. Open the JSON > Parse JSON module.

2. Enter the desired JSON string.

sample JSON string that adds a checkbox "checkbox" and selects the option "two":

{ 
"fields": [{ 
"field_id": "checkbox", 
"field_value": ["two"]
}]
}

3. Link the Parse JSON module with the Create a Card module.

4. Open the Create a Card module and map the module that contains the JSON string for selecting the checkbox option.

5. The card that contains the selected checkbox has been created.

Delete a Card

Deletes a card.

Connection	Establish a connection to your Pipefy account.
Card ID	Enter (map) the ID of the card you want to delete.

Get a Card Info

Retrieves information about a selected card.

Connection	Establish a connection to your Pipefy account.
Card ID	Enter (map) the ID of the card you want to retrieve information about.

List Cards

Retrieves cards from a selected pipe.

Connection	Establish a connection to your Pipefy account.
Pipe ID	Select the pipe you want to list cards from.
Card name	You can filter returned cards by an entered term.
Order	Select the ordering of the returned cards.
Limit	Set the maximum number of results that {{Make}} will return during one cycle.

Move a Card to Phase

Moves a card to the desired phase.

Connection	Establish a connection to your Pipefy account.
Mode	Select whether you want to map the Card ID and Phase ID or select Organization, Pipe, Card, and Phase manually.

Update a Card

Updates a card.

Connection	Establish a connection to your Pipefy account.
Card ID	Select or map the Card ID whose details you want to update.
Title	Enter a new name for the card.
Due Date	Enter a date by which the card is due. See the list of supported date and time formats.
Organization	Select or map the organization to whose assignees you want to assign the card.
Assignees	Enter a comma-separated list of Assignee IDs to whom you want to assign the card.

Update a Card Field

Connection	Establish a connection to your Pipefy account.
Mode	Select whether you want to enter or map the Card ID and Field name or select Organization, Pipe, Card, and Field manually.
New Value	Enter the new value for the card field you want to update.

Get a Phase

Returns phase details.

Connection	Establish a connection to your Pipefy account.
Mode	Select or map the mode whose card phase details you want to retrieve.
Pipeline ID	Select or map the Pipeline ID whose card phase details you want to retrieve.
Card name	Enter the card name whose phase details you want to retrieve.
Order	Select or map the order of the phase whose details you want to retrieve.
Limit	Set the maximum number of phases {{Make}} will return during one execution cycle.

Tables

Create a Table

Creates a table.

Connection	Establish a connection to your Pipefy account.
Name	Enter a name for the new table.
Organization ID	Select the organization you want to create a table for.
Description	Enter the description of the new table.
Authorization	Read/WriteThe users authorized to access this table can add, edit and remove records. ReadThe users authorized to access this table can only view the records.
Public	If this option is enabled, all team members will have access to this table. Otherwise, only invited users will have access to this table.

Create a Table Record

Creates a record in a selected table.

Connection	Establish a connection to your Pipefy account.
Table ID	Select the table you want to create a new record in.
Fields	Field ID Select the field you want to create. Value Enter the value for the above selected field.
Title	Enter the title for the new table record.
Due date	Enter the date and time. List of supported date and time formats.

Delete a Table Record

Deletes a record from a table.

Connection	Establish a connection to your Pipefy account.
Record ID	Enter (map) the ID of the record you want to delete.

Get a Table Record

Retrieves details about a record from a table.

Connection	Establish a connection to your Pipefy account.
Record ID	Enter (map) the ID of the record you want to retrieve information about.

List Table Records

Returns a list of records from a selected table.

Connection	Establish a connection to your Pipefy account.
Table ID	Select or map the table you want to list records from.
Order	Select the ordering of the returned records.
Limit	Set the maximum number of records that {{Make}} will return during one execution cycle.

Update a Table Record

Updates a record in a table.

Connection	Establish a connection to your Pipefy account.
Record ID	Enter (map) the ID of the record you want to update.
Table ID	Select the table that contains the record you want to update.
Fields	Select the field and enter its new value.

Other

You can call APIs using the following module.

Make an API Call

Allows you to perform a custom API call.

Connection	Establish a connection to your Pipefy account.
	Please enter the complete GraphQL query. E.g.`{ allCards(pipeId:850020) { edges { node { id title assignees { id } comments { text } comments_count current_phase { name } done due_date fields { name value } labels { name } phases_history { phase { name } firstTimeIn lastTimeOut } url } } } }` For the list of available endpoints, refer to the Pipefy GraphQL Queries documentation.
Method	Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Example of Use - List all cards in the specified pipe

The following API call returns all cards in the pipe with the Pipe ID 850020:

Matches of the search can be found in the module's Output under Bundle > Body > data > allCards > edges.

In our example, 10 cards were returned:

Execute a GraphQL Query

Connection	Establish a connection to your Pipefy account.
Method	Select the GraphQL method: Get (introspection query) POST (queries and mutations)
Query	Enter the request query.
Operation name	Enter the operation name.
Variables data source	Select the data source to provide variables. For example, `form or collection`.
Variables	Add the Key-Value pair of variables.

Prev	Up	Next
Pinboard	Home	Pivotal Tracker