Skip to main content

Pipefy Developers

Welcome to the Pipefy Developer hub. You'll find comprehensive guides and documentation to help you start working with pipefy as quickly as possible, as well as support if you get stuck. Let's jump right in!

225 Topics
matt171
matt171New Member
asked in API
Can we see who moved a card into a phase via GraphQL?

We would like to see who has moved a card into a phase, through a graphql query. This information is visible through Activity History in the UI but we can’t seem to get it via the API.(We have tried to use the phase_history field in graphql but it lacks the user id.) Is there a way to do this? Thanks  

2251
tsartori
3 years ago
genietim
genietimPipefy Legend
posted in API
How to Query DataBase Table's WebHooks

The GraphQL API of Pipefy provides the function of WebHooks: you can register them, so that upon a certain action, an URL you specify is called, which enables you to use the GraphQL API to develop your own integrations and automations. These WebHooks can be registered for both Database Tables and Pipes. But: to query them, to check which WebHooks are registered on a pipe, the Documentation does not provide a straight-forward way: The object you are looking for is Webhook, and as you can see in Pipe, there is a field ‚webhooks‘ linking to said object; in Table or TableRecord, there is not. So, what is the trick? How can I query which WebHooks are attached to a DataBase?The trick is not obvious, but straight-forward: use the database id as a pipe id!Like this:query { pipes(ids:["yourTableId"]) { id webhooks{ id url name headers actions } }} 

4404
Roberto Chavarria
Pipefy Staff
3 years ago
jnihorimbere
jnihorimbereNew Member
asked in API
Setting assignee via contact id number to a table record field

Hi, I’m trying to update/add assignee to a table record field using their contact ID but I’ve been struggling terribly. I can update/add other record fields, using setTableRecordFieldValue, such as email address and phone numbers but the assignee one return empty value ({'data': {'setTableRecordFieldValue': {'table_record': {'id': 'record_id', 'title': 'record_name'}, 'table_record_field': {'value': '[]'}}}}).I’m really new to this pipefy api, can anyone please help?

2464
tsartori
3 years ago
joaogalhardo
joaogalhardoNew Participant
asked in API
How to convert GraphQL query to JSON ?

Hello guys, EnglishI’m trying to connect a whatsapp chatbot to pipefy through API. Problem is chatbot uses JSON API to make calls. How can I convert GraphQL to Json ?PT-BR Estou tentando integrar um chatbot de whatsapp para fazer a criação de cards no pipefy através da API. Porém na configuração do step no chatbot ele só aceita código JSON. Como faço para converter a query de GraphQL para o código JSON?     mutation{  createCard(input:{          pipe_id:XXXXXXX,          phase_id:XXXXXXX,          fields_attributes: [              {field_id:"sua_empresa", field_value:"Teste"},              {field_id:"seu_nome", field_value:"test"}                 ]})          {card {id}}     }    

26773
joaogalhardo
3 years ago
tsartori
tsartoriSuperuser
asked in Customs Apps & Integrations
Zapier Conection

Hello, I used to use Zapier to conect pipefy and other services that we use here, but since yesterday i cant reconect my pipefy acc through Zapier, keeps showing me the error unauthorized message. Anyone else with this kind of problem??

1719
tsartori
3 years ago
login7
login7New Member
asked in API
Error 3000 - Algo deu errado GraphQL

Boa tarde a todos, estou tentando criar um card via graphql, só que a api está me retornando erro. Alguem sabe oque pode ser? mutation { createCard( input: { pipe_id: {{pipe_code}} fields_attributes: [ { field_id:"c_digo_da_entrega_no_fornecedor", field_value:"""{{table4.selectedRow.data.freight_partner_external_id}}""" }, { field_id:"valor_do_frete", field_value: """{{table4.selectedRow.data.freight_price?table4.selectedRow.data.freight_price:0}}""" }, { field_id:"hor_rio_limite_de_chegada_para_carregamento_1", field_value:"""{{table4.selectedRow.data.freight_scheduled_delivey_datetime}}""" }, { field_id:"link_de_acompanhamento_1", field_value:"""{{table4.selectedRow.data.freight_tracking_link}}""" }, { field_id:"nome_do_motorista_1",

6433
Marcos Carvalho
Pipefy Staff
3 years ago
tsartori
tsartoriSuperuser
asked in Customs Apps & Integrations
Error with Zappier

Hello, I use Zappier to integrate Pipefy to other CRMs, but often i keep reciving an error about a field in Pipefy which dont expect some kind of data. Do exists a reference of what data each field supports? This is the error that Zapier returns me, but i dont understand why sometimes the connection works and with some cards no. 

1653
tsartori
3 years ago
caio-marques1
caio-marques1New Member
asked in API
Pipefy is currently experiencing technical difficulties

SOLVED Hello everybody.We are trying to use Pipefy API query cards to retrieve all cards of a pipe (https://api-docs.pipefy.com/reference/queries/#cards).Our requests were working fine until one week ago. From that time we are always retrieving a HTML as response with "Pipefy is currently experiencing technical difficulties".Does anybody have any clue about this issue?Thanks a lot.Caio

1782
tsartori
3 years ago
apoluyanov
apoluyanovRegular Participant
asked in API
API: bulk operations for database records

Hi,I am building an app to keep Database in pipefy in sync with external source. This database contains thousands of records that are added and updated on the daily basis.I’ve tried to use recordsImporter in GraphQL API to sync records, but it seems like it can only create records, but not update it. Is it correct? Are there any other ways to create/update/delete records in bulk through API or is it only possible to do it one by one?  Best Regards, Artem

5172
apoluyanov
3 years ago
tsartori
tsartoriSuperuser
asked in API
Graphql cards dont export in the same order

Hello, When i make a request with the graphql, the response is in a different order for each card, what makes trouble for putting into a DataFrame. Ex: Sometimes the response is given by: Title, date, owner. But in a couple of cards the response is: Owner, title, date. May someone help me? 

1993
genietim
3 years ago
Caio Santos
Caio SantosNew Participant
asked in API
Some cards from pipe aren't being returned in API

I'm trying to query all cards from pipe using Pipefy API Graphql, but some cards that appear in the pipe board aren't being returned in the api.In the code below I'm trying get all cards from my Pipe{ pipe(id: 1260940) { phases { id, name, cards { edges {node { id, createdAt, fields { name value } }}} } }}Or if I search directly in the phase where are these "hidden" cards{ phase(id: 8422613) { cards { edges { node { id } } } }}For example: the card #426803396, that is in this pipe (1260940) and this phase (8422613), isn't returned in any those queries above.

6372
Nicole Chiroli
Pipefy Staff
3 years ago
caio-lopes1
caio-lopes1New Participant
asked in API
Webhook and attachments

Dear all, Currently we are using the webhook API with some attachements, but we can't figure out the full path of the uploaded item:This is a response example "uploads/04442dae-6d3a-43a9-bd62-5b61e8d61def/Gui.png"Do you have any idea? Regarda

2632
genietim
3 years ago
ivan99
ivan99New Member
asked in Customs Apps & Integrations
How do I add data in connector type fields through API?

 Hi, I'm starting API development. I'm able to create a card through my environment using GraphQL, but I'm not able to add data to a connector type field. Field information: { "id": "contatos", "type": "connector", "index_name": "field_29_connector", "description": "", "label": "Contatos:", "allChildrenMustBeDoneToFinishParent": false, "canConnectExisting": true, "connectedRepo": {} }, 

5701
genietim
3 years ago
Carlos Basques
Carlos BasquesNew Member
asked in API
Query no GraphQL para filtrar cards de um determinado Cliente (CPF)

Olá, Estou tentando fazer uma query para filtrar todos os cards de um determinado CPF, porém não está funcionando, é possível utilizar campo customizado no filtro ou apenas os campos fixos do sistema?Obg.

4802
Carlos Basques
3 years ago
rdavidsc
rdavidscNew Member
asked in API
problem with GraphQL auth | NodeJS

Hi there:I’m trying to make querys from a server using NodeJS and always get error 401 “you are not authorized to access this page”  const url = 'https://api.pipefy.com/graphql';const options = {method: 'POST',headers: {Authorization: '***MY_TOKEN***','Content-Type': 'application/json'},body: JSON.stringify({query: '{ me { name } }'})}  The thing is, I'm using the example in the documentation but it doesn't work. What I am doing wrong?  

6402
rdavidsc
3 years ago
jon71
jon71New Participant
asked in API
Update phasefield using GraphQL API (How do I specify a phase?)

Hi,I am trying to update phase fields in my Pipe using the following GraphQL query:mutation { updatePhaseField( input: { id: "did_you_finish_the_task" label: "Have you finished the task?" options: ["Yep", "Nope"] required: false editable: true } ) { phase_field { id label } }}As far as I can tell the only way to specify the field is through the field ID. However my account is linked to many boards and companies and there are duplicate IDs across those. For example there could be multiple fields with IDs "did_you_finish_the_task" and I don’t want to accidentally rename the wrong one.So my question is how do I specify a certain field in a certain phase or board?

6175
genietim
3 years ago
Juliana Spinardi
Pipefy Staff
Juliana SpinardiPipefy Staff
published in Customs Apps & Integrations
Apps Client SDK

IntroductionUse the Client SDK to interact with the our Apps framework directly from your iframe. The SDK provides a PipefyApp  global object that allows cross-frame communication between your app and the host Pipefy product.  🔎 Getting the SDKImport the Pipefy Client SDK from  https://platform.staticpipefy.com/pipefy-app.js  Example: 🔎 Using Client SDKOn your Initial page defined by init_url 🔎 On your iframes inside dropdowns, modals, tabs and  sidebars ☝️ CUSTOM APP DATA  p.set(scope, visibility, key, value) - Store data on Pipefy relative to a card, pipe or organization. Apps can only access their own stored data. 🔎 Scope  🔎 Visibility  🔎 p.get(scope, visibility, key) - Get data that the App stored, based on scope, visibility and key passed by parameters. 🔎 p.attach({url, name}) - Attach a link to card sending URL and name. Apps can claim these attachments later and render properly.🔎 p.detach(id) - Detach a link from the current card. Apps can only detach attachments that t

5855
genietim
3 years ago
genietim
genietimPipefy Legend
asked in Customs Apps & Integrations
What are the GraphQL API Limits?

I can imagine that there are certain limits to the GraphQL API. For example: - number of subsequent queries allowed per time unit - number of webhooks allowed - size of inputs/outputs - size of attachment files What are the numerical values of these (and possibly more) limits?

16562
Marcos Carvalho
Pipefy Staff
3 years ago
Juliana Spinardi
Pipefy Staff
Juliana SpinardiPipefy Staff
published in API
Introduction | What is GraphQL?

The GraphQL data query language is: A specification. The spec determines the validity of the schema on the API server. The schema determines the validity of client calls. Strongly typed. The schema defines an API's type system and all object relationships. Introspective. A client can query the schema for details about the schema. Hierarchical. The shape of a GraphQL call mirrors the shape of the JSON data it returns. Nested fields let you query for and receive only the data you specify in a single round trip. An application layer. GraphQL is not a storage model or a database query language. The graph refers to graph structures defined in the schema, where nodes define objects and edges define relationships between objects. The API traverses and returns application data based on the schema definitions, independent of how the data is stored. It allows for reading and writing through queries and mutations (see GraphQL documentation). 📌Authentication For authentication against Pip

35862
genietim
3 years ago
Juliana Spinardi
Pipefy Staff
Juliana SpinardiPipefy Staff
published in Customs Apps & Integrations
Publishing you App

 Publishing you AppWe will detail more about our review process, right now you can send a request using the following link:http://app.pipefy.com/public_form/272394

880
Juliana Spinardi
Pipefy Staff
3 years ago
Juliana Spinardi
Pipefy Staff
Juliana SpinardiPipefy Staff
published in Customs Apps & Integrations
Frequently Asked Questions

What do I need to do to let Pipefy access my App?Your application needs to accept CORS requests from https://app.pipefy.com, you can find more info about CORS here: https://enable-cors.org 👆 What is the best way to get started?Remix our Emoji sample app, add to your organization, or edit and see your changes live in Pipefy. 

1190
Juliana Spinardi
Pipefy Staff
3 years ago
Juliana Spinardi
Pipefy Staff
Juliana SpinardiPipefy Staff
published in Customs Apps & Integrations
Features

Using our powerful Apps framework and sample projects, easily build new Apps. CARD-BADGES - icons or symbols that represent actions on your cards Add badges to closed card, you can use the Live version when you need to get other card data, make external requests or need to have a refresh interval. You can use the Fixed version if you don't need that.   Receivep: Pipefy Client context: Object with Pipe and Card ReturnExpect to return an Array of card badges Livelive: Expect to return Promise that resolves a Card badge object, same options from Fixed example refreshInterval: Number of seconds to refresh and call live function. Minimum of 20 seconds Fixedtext: Text to be displayed inside badge icon: SVG relative path or full URL, svg fill color must be equal to #9AAABE color: Background colors, available options are  red ,  yellow ,  green  and  blue . title: HTML Title that will be displayed when user hover the badge CARD-BUTTONS - Activate a feature on a card with a clickable button.Add

1840
Juliana Spinardi
Pipefy Staff
3 years ago
Juliana Spinardi
Pipefy Staff
Juliana SpinardiPipefy Staff
published in Customs Apps & Integrations
Manifest reference

More details about attributes inside manifest.json  Sample:  Properties   

1040
Juliana Spinardi
Pipefy Staff
3 years ago
Juliana Spinardi
Pipefy Staff
Juliana SpinardiPipefy Staff
published in Customs Apps & Integrations
Welcome to the Pipefy Developers!

Welcome to the Pipefy Developers ! Here you can find documentation on how to develop your own Pipefy App and on how to use GraphQL API query language to extend Pipefy capabilities.Pipefy is a process platform designed to standardize and advance business workflow processes. Users can create custom workflows, generate reports to find process bottlenecks, centralize communications, and improve overall productivity by using Pipefy.The Pipefy Developers is an open space where developers can build powerful products on Pipefy’s platform. Create game-changing process advancements for your team or for managers in +15k companies around the world.What you can do on the Pipefy Developers: 

3120
Juliana Spinardi
Pipefy Staff
3 years ago
F
Pipefy Staff
Felipe ScholzPipefy Staff
published in Customs Apps & Integrations
Integrate Pipefy with other tools using Custom Integrations! ⚙️News

Hello Doers!  We have some exciting news to share with you! Later this year we’ll officially launch a new way to integrate Pipefy with other tools. This will empower our users to ensure the transmission of information between different parties is automatic and error-proof and be confident that the entire operation is visible and controlled in a single place.  I’m talking about things like: Updating employee personal information, posting job openings to job boards and collecting signatures Optimizing reconciliation, synchronizing purchase information, controlling cash flow and updating balance sheets Managing NPS, churn requests, updating directories, customer documents and support tickets’ statuses Sending automatic SMS texts to requesters and stakeholders  The sky is the limit. And the great news is: new customers will only get access to Custom Integrations depending on their contract. But we are making this add-on available to all of our current customer base as a way to thank

20867
dgodfrey
3 years ago

Community Experts Leaderboard

Terms & ConditionsCookie settings