Pipefy

Adding the data source

Requirements

  • Follow the instructions below with an user with “company administrator” access

Instructions

1) Log in to your Pipefy account, click on the top right corner menu and then “Account preferences”

2) Select the “Personal access tokens” section and then click on “Generate new token” if you want to generate a new one or nodes 3 vertical dots next to an existing token if you want to use it

3) Copy the value of “Token value”

4) Login to the Kondado platform, go to the add data source section and select the Pipefy data source

5) Name your data source and, in Token, paste the value obtained in step 3

Now just click SAVE to start receiving data from Pipefy in your Data Warehouse or Data Lake

Pipeline

Summary

Relationship Chart

Organizations

Main Object

Field Type

id

float

[en] The organization ID

billing_billingnoticeperiod

boolean

billing_pastduenoticealert

boolean

billing_upgradeonlyfreeplan

boolean

createdat

timestamp

[en] When the organization was created

createdby_id

float

[en] The user ID

createdby_name

text

[en] The user name

customlogourl

text

[en] String The organization logo URL

freemium

boolean

memberscount

float

[en] Quantity of members of the organization

name

text

[en] The organization name

onlyadmincancreatepipes

boolean

[en] Whether only Admins can create pipes

onlyadmincaninviteusers

boolean

[en] Whether only Admins can invite new users

permissions_invitemember

boolean

permissions_showcompanyreports

boolean

permissions_showcreatepipebanner

boolean

permissions_showdashboard

boolean

permissions_showdashboardmobile

boolean

permissions_showinvitemember

boolean

permissions_showmytasks

boolean

permissions_showportals

boolean

permissions_showrepolist

boolean

planname

text

role

text

[en] Current user's role in the organization

usermetadata_cancreatepipe

boolean

[en] Whether the user can create a new pipe

usermetadata_caninviteuser

boolean

[en] Whether the user can invite another user to this organization or not

uuid

text

[en] The organization UUID

pipefy_organizations__members

Field Type

organization_id

float

[en] The organization ID

members_role_name

text

[en] The user role name. Valid roles: 1. Organization: - admin: Team admin, can view/join all pipes and access/manage the team settings; - normal: Team member, can view and join all public pipes; - guest: Team guest, is free and can only create cards. 2. Pipe: - admin: Pipe admin, can create and edit cards as well as manage the pipe settings; - member: Pipe member, can create new cards as well as access the existing ones to edit and move them across the pipe; - creator: Pipe start form only, has limited access to the pipe - can create cards; - my_cards_only: Pipe restricted view, can create new cards but is only allowed to view/edit cards created by or assigned to him; - read_and_comment: Pipe read only, can view the cards and add comments. 3. Database Table: - admin: Table admin, can create an edit records, edit the table and its settings; - member: Table member, can view and create records (if authorized on the settings).

members_user_displayname

text

[en] The user display name

members_user_email

text

[en] The user email

members_user_name

text

[en] The user name

members_user_username

text

[en] The user username

members_user_id

float

[en] The user ID

pipefy_organizations__users

Field Type

organization_id

float

[en] The organization ID

users_displayname

text

[en] The user display name

users_email

text

[en] The user email

users_id

float

[en] The user ID

users_name

text

[en] The user name

users_username

text

[en] The user username

Pipes

Main Object

Field Type

id

float

[en] The pipe ID

organizationid

float

[en] Card organization id

    Organizations > > id

cards_count

float

[en] The pipe total cards

clone_from_id

float

[en] Id which the Pipe was cloned from

create_card_label

text

[en] The content displayed in the start form button

created_at

timestamp

[en] When the pipe was created

description

text

[en] The Repo description

emailaddress

text

[en] The pipe's email inbox address

expiration_time_by_unit

float

[en] The number used in the pipe SLA

expiration_unit

float

[en] The seconds of the unit used in the pipe SLA

anyone_can_create_card

boolean

[en] Whether anyone can create cards in the pipe

icon

text

[en] The Repo icon

last_updated_by_card

timestamp

[en] When a card was last updated in the pipe

name

text

[en] The Repo name

noun

text

[en] The Repo noun for their registries

only_admin_can_remove_cards

boolean

[en] Whether only Admins can delete cards

only_assignees_can_edit_cards

boolean

[en] Whether only the card assignees can edit it

opened_cards_count

float

[en] The total amount of cards not done

permissions_configure_repo

boolean

permissions_create_item

boolean

permissions_delete_item

boolean

permissions_delete_repo

boolean

permissions_manage_field

boolean

permissions_manage_label

boolean

permissions_show_repo

boolean

public

boolean

[en] Whether the Repo is public

role

text

[en] The current user role in the pipe

startformphaseid

float

[en] The repo start form phase id

suid

text

[en] The pipe Small Unique ID

users_count

float

[en] The total users in the pipe

uuid

text

[en] Unique identifier id

pipefy_pipes__labels

Field Type

pipe_id

float

[en] The pipe ID

labels_color

text

[en] Represents the color used in the label using a hexadecimal string.

labels_id

float

[en] Represents the label identifier.

labels_name

text

[en] Represents the label name.

pipefy_pipes__members

Field Type

pipe_id

float

[en] The pipe ID

members_role_name

text

[en] The user role name. Valid roles: 1. Organization: - admin: Team admin, can view/join all pipes and access/manage the team settings; - normal: Team member, can view and join all public pipes; - guest: Team guest, is free and can only create cards. 2. Pipe: - admin: Pipe admin, can create and edit cards as well as manage the pipe settings; - member: Pipe member, can create new cards as well as access the existing ones to edit and move them across the pipe; - creator: Pipe start form only, has limited access to the pipe - can create cards; - my_cards_only: Pipe restricted view, can create new cards but is only allowed to view/edit cards created by or assigned to him; - read_and_comment: Pipe read only, can view the cards and add comments. 3. Database Table: - admin: Table admin, can create an edit records, edit the table and its settings; - member: Table member, can view and create records (if authorized on the settings).

members_user_displayname

text

[en] The user display name

members_user_email

text

[en] The user email

members_user_name

text

[en] The user name

members_user_username

text

[en] The user username

members_user_id

float

[en] The user ID

pipefy_pipes__users

Field Type

pipe_id

float

[en] The pipe ID

users_displayname

text

[en] The user display name

users_email

text

[en] The user email

users_id

float

[en] The user ID

users_name

text

[en] The user name

users_username

text

[en] The user username

pipefy_pipes__webhooks

Field Type

pipe_id

float

[en] The pipe ID

webhooks_id

float

[en] The webhook ID

webhooks_name

text

[en] The webhook name

Phases

Field Type

id

float

[en] The phase ID

pipe_id

float

[en] The pipe ID

    Pipes > > id

name

text

[en] The phase name

cards_count

float

[en] The phase total cards

created_at

timestamp

[en] When the phase was created

description

text

[en] The phase description

done

boolean

[en] Whether it is a final phase

expiredcardscount

float

[en] The phase total expired cards

index

float

[en] The phase positional index

latecardscount

float

[en] The phase total late cards

sequentialid

float

[en] The sequential identifier

Cards

Main object

Campo Tipo

id

float

[en] ID The card ID

age

float

[en] The seconds since the card was created

attachments_count

float

[en] The card total attachments

checklist_items_checked_count

float

[en] The card total checked items

checklist_items_count

float

[en] The card total checklist items

comments_count

float

[en] The card total comments

createdat

timestamp

[en] When the card was created

createdby_displayname

text

[en] The user display name

createdby_email

text

[en] The user emailThe user email1

createdby_id

float

[en] The user ID

createdby_name

text

[en] The user name

currentlateness_becamelateat

text

currentlateness_id

float

currentlateness_shouldbecomelateat

text

currentlateness_sla

float

current_phase_id

float

[en] The phase ID

    Phases > > id

current_phase_age

float

[en] The seconds since the card entered current phase

done

boolean

[en] Whether the card is done

due_date

timestamp

[en] The card due date

emailmessagingaddress

text

[en] The card email address

expired_at

timestamp

should_expire_at

timestamp

expired

boolean

[en] Whether the card is expired

finished_at

timestamp

[en] When the card was finished

inboxemailsread

boolean

[en] Information about any inbox email read status

late

boolean

[en] Whether the card is late

path

text

[en] The card path

started_current_phase_at

timestamp

[en] When the card first entered the current phase

suid

text

[en] The card ID

title

text

[en] The card title

updated_at

timestamp

[en] When the card was last updated

url

text

[en] The card URL

uuid

text

[en] The card Unique UUID

pipefy_cards__labels

Campo Tipo

card_id

float

[en] ID The card ID

labels_color

text

[en] Represents the color used in the label using a hexadecimal string.

labels_id

float

[en] Represents the label identifier.

labels_name

text

[en] Represents the label name.

pipefy_cards__phases_history

Campo Tipo

card_id

float

[en] ID The card ID

phases_history_phase_id

float

[en] The phase id

    Phases > > id

phases_history_phase_name

text

[en] The phase name

phases_history_became_late

boolean

[en] Whether or not the card ever became late on a phase.

phases_history_created_at

timestamp

[en] Represents the date and time of when the card first entered the phase.

phases_history_draft

boolean

[en] Whether or not the phase detail is in the start form.

phases_history_duration

float

[en] Represents the seconds card stayed in the phase.

phases_history_firsttimein

timestamp

[en] Represents the date and time of when card first entered the phase.

phases_history_lasttimein

timestamp

[en] Represents the date and time of when card last entered the phase.

phases_history_lasttimeout

timestamp

[en] Represents the date and time of when card left the phase.

pipefy_cards__summary

Campo Tipo

card_id

float

[en] ID The card ID

summary_title

text

[en] Represents the title of the selected field to be represented in the summary.

summary_type

text

[en] Field type

summary_value

text

[en] Represents the value of the selected field to be represented in the summary.

pipefy_cards__subtitles

Campo Tipo

card_id

float

[en] ID The card ID

subtitles_array_value

text

[en] The value of an Attachment, Checklists, Connection or Label field, processed as an array type

subtitles_assignee_values

text

subtitles_date_value

text

[en] The value of a Date, DateTime or DueDate field, processed as a date type

subtitles_datetime_value

text

[en] The value of a DateTime or DueDate field, processed as a date and time type

subtitles_filled_at

timestamp

[en] When the field was filled

subtitles_float_value

text

[en] The field float value

subtitles_indexname

text

[en] The searcheable name

subtitles_name

text

[en] The field name

subtitles_report_value

text

[en] The field value prepared for report

subtitles_updated_at

timestamp

[en] When the field was last updated

subtitles_value

text

[en] The field value

pipefy_cards__fields

Campo Tipo

card_id

float

[en] ID The card ID

fields_array_value

text

[en] The value of an Attachment, Checklists, Connection or Label field, processed as an array type

fields_assignee_values

text

fields_name

text

[en] The field name

fields_report_value

text

fields_updated_at

timestamp

fields_value

text

pipefy_cards_parents

Campo Tipo

card_id

float

[en] The (child) card ID

parent_card_id

float

[en] Represents the id of the parent card

    Cards > > id

parent_card_title

text

[en] The title of the parent card

Databases

Field Type

record_id

text

[en] Databases entity ID

record_updated_at

timestamp

[en] Timestamp of when record was last updated

record_created_at

timestamp

[en] Timestamp of when record was created

property_x

text

[en] an example of a dynamic property

property_y

float

[en] an example of a dynamic property

property_z

date

[en] an example of a dynamic property