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!

195 Topics

daniel-levy2
daniel-levy2New Participant
asked in API

Trouble with error handling on Card Move through API

Hello everyone,I am developing a simple application that will be integrated with Pipefy, and I will need to allow cards to be moved between phases with calls to the GraphQL API. The issue I am having is that there are certain fields that need to be updated before a card can move to a particular phase. When those fields are not set and the API call is made, the error that returns is very general: “Card could not be moved to phase id: <ID>”Is there anyway to make this error message more specific so that I could display to the user why it is failing? I thought I was able to do it when experimenting through Postman but now I cannot seem to find the call I madeAny help on this would be greatly appreciatedThanks!

1
genietim
2 years ago
juliamsantarosa
juliamsantarosaRegular Participant
asked in Customs Apps & Integrations

Date enters the phase

Hello community!How do I find out the date the card entered the phase?Thanks for the attention.

3
alicereis
2 years ago
Marcos Carvalho
Pipefy Staff
Marcos CarvalhoPipefy Staff
published in API

💡 Pipefy User Management API

Hi everyone! It’s Marcos from Pipefy Engineering team.  Pipefy has released a new set of functionalities in our GraphQL API to enable user management in Organizations (a company’s account in Pipefy), Pipes (processes) and Tables (databases). New mutations, queries and webhooks were created in order to manage users and their roles through API, enabling many possibilities of integrations between Pipefy and Active Directory or any other user provisioning application and helping administrators to have more control, governance and security over organization users. Here some more details about these new possibilities in our API documentation Changelogs:  User Management Mutations ​​​​​​User Management Webhooks For more information, please refer to Pipefy Developers page. Hope you like it and if you have any questions or suggestions, please let us know!  

3400
Marcos Carvalho
Pipefy Staff
2 years ago
Tegrus
TegrusRegular Participant
asked in API

Get child pipes in pipe query

I can’t get information about the child/parent pipes in Pipe query. I make a query like this one below:{ pipe(id: "form id here") { childrenRelations { child { __typename } } }}And the only property I can get from the child/parent is __typename and the result is this:{ "data": { "pipe": { "childrenRelations": [ { "child": { "__typename": "Pipe" } } ] } }}I want to know at least the child pipe ID. I tried the pipe_relations query, but it has the same limitations. The only way I could get some information about the pipes in the relations was in card query, but I need that information before a card is created.

1
genietim
2 years ago
Marcos Carvalho
Pipefy Staff
Marcos CarvalhoPipefy Staff
published in API

💎 Pipefy GraphQL API Reference documentation is now updated!

Hey everyone! Pipefy GraphQL API Reference documentation https://api-docs.pipefy.com is now updated!In this new version we fixed some broken links and also all latest mutations, queries or any other changes in our GraphQL API are now available. This is way of improving even more Pipefy integrations capabilities and deliver better documentation to our customers and developers community.But it's important to remember that our official documentation page is https://developers.pipefy.comThis is the home page where developers can have access to other documentation features like code examples, articles about GraphQL and many more.When it’s necessary a more in depth documentation, then the GraphQL API Reference is the place for it! It's a reference containing all possibilities to work with the Pipefy API explaining the concepts of Card, Pipe, Table, etc. and also available fields, required fields and their data types.We hope you like it and feel free to give us feedbacks and ideas. 

6422
Marcos Carvalho
Pipefy Staff
2 years ago
lucass-web
lucass-webNew Participant
asked in API

Issue in graphql pagination parameters

Hello everyoneI have a query to filter set of cards using CardSearch as example: above, has the query and the search result, the pagination parameters returned inform that I have more pages to be seen when I update the query to bring up the next page, I get the following return the curious thing is that there are card titles where pagination works normally, for example:for cards with title = "Almir Mario Bitto" the pagination does not work.for cards with title = "Filipe Gomes de Lima" pagination works normally    Are there any details to be adjusted in the query?I appreciate any help

2
Alex Dowbor
2 years ago
Lucas Democh
Lucas DemochPipefy Legend
published in API

Solutions for Tag Update via API

I identified 3 ways to update tags through GraphiQL. You should use the most appropriate format for your process. Scenario A) Updating a single tag. Solution 1: This is the simplest scenario and should only be used if your Pipe has only one label field. mutation{ updateCardField(input: {          card_id: XXXXXXXX field_id:"label_1"          new_value:"XXXXXXXX" }) { clientMutationId success } }In this format, as the update is from a field to a label, there is no problem. Scenario B) Updating multiple labels in different fields. For this scenario, there are several solutions, as simply updating the label fields does not guarantee that the card labels are properly updated / synchronized with the Card labels. Solution 2: Update more than one tag field, each field with a tag.mutation{ m1: updateCardField(input:{ card_id:XXXXXXXX field_id:"label_1",new_value:"XXXXXXXX" } ) { card { id } }m2: updateCardField(inp

3603
Lucas Democh
2 years ago
davi96
davi96Regular Participant
asked in API

Is there a wait to get a pipe report via API or save a pipe's information to a table that could be pulled via API?

I don’t think it’s possible to directly get a pipe report via API, since I haven’t find anything related in the docs. Anyway, I’d be happy if I’m wrong on that.However, I can directly pull tables  - from the “database” feature - via API. So a workaround on pulling reports would be to connect the pipe to a table and then pull this table using the API. To be more precise on what I mean to connect pipe and table: create some kind of automation that would, for example, save to a table every cards’ id, title and current phase. Is there a way to do something similar?

4
davi96
2 years ago
jason147
jason147Regular Participant
asked in API

Update database with connected cards

Hi, I was wondering what API to use for updating databases based on their connected cards e.g. Data gets updated so I need to auto update the database OR a card gets moved to archive so I want to remove the Data I am someone with very little coding knowledge (But I am learning, currently with html but moving onto python)

1
Lucas Democh
2 years ago
davi96
davi96Regular Participant
posted in Customs Apps & Integrations

How to test if webhook is working?

I created a webhook in a pipe in order for it to export data to a Google Cloud Function that will, in turn, send it to a Google Cloud Pub/Sub topic.The Cloud function is all set up and tested, surely working when I do a POST request using curl with the same token.I set up the webhook using https://app.pipefy.com/graphiql with the following piece of code:mutation{ createWebhook(input:{ actions:"card.move" name:"Webhook-Test" url:"https://MY_CLOUD_FUNCTION_URL" email:"MY_EMAIL@MY_COMPANY.com" pipe_id:302214108 headers: "[{\"Authorization\":\"Bearer MY_VERY_LONG_TOKEN\"}]" }) { clientMutationId }}And it actually does create a webhook, as I could verify with the following piece of code:{pipe(id:302214108){id webhooks{id url headers actions}}}However, when I move some cards to test it, I don’t see any invocation in the cloud function dashboard. Is there a way to test and monitor the webhook? Any ideas that could help solve this? I’m totally lost with this, since I

3
Lucas Democh
2 years ago
davi96
davi96Regular Participant
asked in API

Info {"errors":[{"message":"Unexpected end of document","locations":[]}]}

I’m trying to get data from a pipe using Google Apps Script and keep getting the error:Info {"errors":[{"message":"Unexpected end of document","locations":[]}]}I don’t think the problem is with the general script’s structure, since it works when I run another query.Also, I’m new to GRAPHQL - this is the first time I use it, for instance - so that’s another reason why I believe the problem might be in the query.A piece of the script I used to try is: const query = `{ allCards(pipe_id:${pipe_id}){ edges{ node { title current_phase { name } createdBy { name } createdAt fields { value name } } } }`; const graphql = JSON.stringify({ query: query, variables: null, }); const params = { method: "GET", payload: graphql, headers: { "Content-Type": "application/json", Authorization: `Bearer ${TOKEN}`, }, }; var response = UrlFetchApp.fetch(url, params);pi

1
davi96
2 years ago
rodolfo-silva5
rodolfo-silva5New Member
asked in API

problem using example in NodeJs

Hi, I'm using node, and I got the example in the documentation, but when I run it, it gives me this error, and on the site where the example is executed, it's running normally.Thanks.Link example: https://developers.pipefy.com/reference/graphql-endpoint Code:sdk['graphql-endpoint']({ query: '{allCards(pipeId: 302194528){edges{node{id}}}}'}, { Authorization: 'Bearer *token*'}) .then(res => console.log(res)) .catch(err => console.error(err)) Response:​{>    '0': {>      instancePath: '/paths',>      schemaPath: '#/additionalProperties',>      keyword: 'additionalProperties',>      params: { additionalProperty: '' },>      message: 'must NOT have additional properties',>      isIdentifierLocation: true>    },>    stack: 'SyntaxError: OpenAPI schema validation failed.\n' +>      '\n' +>      'ADDITIONAL PROPERTY must NOT have additional properties\n' +>      '\n' +>      '  24 |   ],\n' +>      '  25 |   "paths": {\n' +>      '> 26

0
rodolfo-silva5
2 years ago
sommardahl
sommardahlNew Participant
asked in API

You don't have permission to connect these cards/table records.

Hello,I am attempting to create a db record on the GraphQL API. The table (called “Assessments”) has a database connection field called “Candidate”. From the API, as I attempt to set the field values, I add a valid identifier for “Candidate” (candidate exists and the “Candidates” table, the value I’m setting is the title field). IF the same candidate has not been added to another assessment, the mutation is successful. IF the same candidate is already present on another assessment, the mutation fails with the following error: “Error on field "Candidate": Value You don't have permission to connect these cards/table records.” I’d like to stress that THIS QUERY WORKS as long as the Assessments table does not already contain an assessment with the same candidate that I’m attempting to add. So, I don’t personally believe the problem is in the query. I believe the problem might come from my own understanding of how Pipefy works. On the other hand, I definitely expect Pipefy to ALLOW what I’m

1
rafaela-marques2
Pipefy Staff
2 years ago
william-kliemann
william-kliemannRegular Participant
asked in API

Database ID in pipe query

I have a situation and I can't find a solution.I need to make a query to filter a pipe, but in it, I need my client's ID that is filled in it in the databases.That is, I need the pipe query to bring the ID filled in it in the databases.Has anyone been through something like that?

2
genietim
2 years ago
izazueta
izazueta
asked in Customs Apps & Integrations

Access to beta features

Hi, I asked this on the support chat but don’t receive a straight answer.When / How we can get access to beta features in this roadmap https://roadmap.pipefy.com/tabs/15-in-beta? In particular the Card Field Updated trigger for Zapier will be very helpful in our process. Currently we only see the triggers available here https://zapier.com/apps/pipefy/integrations 

5
V
1 year ago
alexander-razumeiko
alexander-razumeikoNew Member
asked in API

GQL Schema

Hi, i am using GQL to build some processes and i’d like to try `gql dsl`, for this i need a graphQL schema. I tried to generate it automatically but i was not able to do it. So my questions: is it publicly available? If yes, where i can get it?

5
arothberg-fa
1 year ago
anilkumblel001
anilkumblel001New Participant
posted in API

200 status code for Error Api response

Team,When I execute a graphql api for few case the api is success and it returns the data.But if we make any mistakes in constructing the query or some other error then that time in the response it has errors but it gives us 200 as API Status code. How can we distinguish success and failure APIs. Can‘t we find this from the API status code ?

1
genietim
2 years ago
dcastelhano
dcastelhanoNew Member
asked in Customs Apps & Integrations

Change index_name from a field

Hi guys, how can i change the index_name of a field, when i create a new field in app.pipefy, the "index_name" is "field_1_date", i need to change this to “due_date” instead of “field_1_date”, in order to integrate with my backend via graphql, that’s possible?Thanks

3
dcastelhano
2 years ago
jnihorimbere
jnihorimbereNew Member
asked in Customs Apps & Integrations

Pipefy card button, card tab and pipe buttons

Hi everyone, I would like to add a card button on every card and when the button is clicked load some sort of a form to be completed and submitted. I don’t know how to. I’ve browsed through the developer documentation but I’m still unable to implement such functionalities. I need some help on the steps to follow and implement this functionalities. Please help.Thanks guys.

2
genietim
2 years ago
davi-fontenele
davi-fonteneleNew Participant
asked in API

Is there an limited number of options on updatePhaseField?

Hey guys! I have a list of 500 options to a select field.When i do it through software screen, i have no trouble:  when i do it through API, if i send about 10 options, all good, but if i send about 20 options, my response is 200 but the options on pipe do not update. =(

2
davi-fontenele
2 years ago
belsalemme
Pipefy Staff
belsalemmePipefy Staff
posted in API

Single Tenant in Pipefy

Have you heard the expressions "single tenant" or "multi tenant" before? As a rule, companies in Pipefy are hosted in a multi-tenant environment, which means that they all coexist and run their processes, automations, integrations and so on in a single, unified cloud.However, some companies opt for the "single tenant" option:In a single tenant scenario, a company “purchases” its own cloud and, therefore, will no longer divide resources and processing queues with other companies, ensuring greater stability and lesser risk of slowness or latency caused by other companies in the same environment.In single-tenancy, a single instance of the software and supporting infrastructure serve a single customer. Each customer has his or her own independent database and instance of the software. Essentially, there is no sharing happening with this option. The separation is physical. Click here to check the new Single Tenant Documentation to learn all about it and whether it's an option your company s

1
rafael.jefte
2 years ago
ramongb
ramongbNew Member
asked in API

What is "clientMutationId" used for?

I see that “clientMutationId” is always needed as part of the GraphQL payload. But What is this for??In the result from GraphQL always come back as NULL. In the Dev Docs says “A unique identifier for the client performing the mutation.” Can I register a Client for the miutation? Thanks!

3
Roberto Chavarria
Pipefy Staff
2 years ago
gabrielcm940
gabrielcm940New Member
asked in Customs Apps & Integrations

p.modal features dont work

I have this code butPipefyApp.initCall({"card-buttons": function (p, pipe) {return [{icon: "./assets/sicronize.png",text: "Buscar informações",callback: openModal,},];},}); var openModal = function (p) {p.modal({url: "https://react-expensify-sample-app.herokuapp.com/",height: "70%",width: "70%",});};   My problem is: The modal keep loading forever. When I inspect the network traffic I can see the response code 200 and the ‘hello world’ content inside the iframe, as expected! but the modal keep loading and does not show the iframe content.

0
gabrielcm940
2 years ago
Marcos Carvalho
Pipefy Staff
Marcos CarvalhoPipefy Staff
posted in API

How to use APIs

Hey everyone!  We’ve been working on a series of articles intended for those who are new to programming and are interested in starting to know more about APIs.  Here the second one on How to use APIs and why they are so important to the digital market nowadays.  Hope you all like it and let’s start some discussions about, I’d love to know your impressions and ideas

1
tsartori
2 years ago
yasmin.valim
Pipefy Staff
yasmin.valimPipefy Staff
published in Customs Apps & Integrations

🤓 Why beginner developers should learn Ruby

This is one more article about one more language and I am one more person trying to convince you that this way is better, right? Not necessarily, but give me time to explain. I am a regular person without a usual background in Computer Sciences. I studied Psychology for years before realizing what I wanted to do for a living was code and I believe that everyone who wants to experiment with this should have at least a chance to try.  Development can be fun and it’s for everyone and that’s why I’m writing this: to all the people who want to start over and don’t know how, to all beginners who don’t have a usual career path, to people on different backgrounds who wants to give a technology a chance and change their lives but don’t know if they really can because they are used to listen “this is not for you” or even for those who already work with technology but want to work with another language and are kind of afraid. This is for you. Technology is for everyone.So, how can Ruby help you w

1501
tsartori
2 years ago

Community Experts Leaderboard

Terms & ConditionsCookie settings