API

Pipefy API

  • 77 Topics
  • 242 Replies

77 Topics

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. 

4062
Marcos Carvalho
Pipefy Staff
1 year 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!  

2080
Marcos Carvalho
Pipefy Staff
1 year ago
Juliana Spinardi
Community Manager
Juliana SpinardiCommunity Manager
published in API

New GraphQL feature: Query/filter cards by updated_at

We are happy to announce that now we support filtering and query card by the updated_at field inside the allCards query. This new feature will avoid the need to look through all cards to find the last updated ones for example.Sample query:Changelogadded: updated_at filter inside allCards root query

4185
Lais Laudari
Community Manager
16 hours ago
contato1705
contato1705Regular Participant
asked in API

Get the late cards from a sprecific pipe using GraphQL

Hey everyone! I’m trying to get all the late cards from a specific pipe. At the moment, i’m using this code here, that gives me all the cards from the pipe and then, on my editor, i filter the late ones:{allCards(pipeId: XXXXXXXX, first: 50)   {pageInfo {    hasNextPage    endCursor  }    edges {      node {        id        late        current_phase{          id}      }    }  }} Is there a way that i can get only the late cards? Like a request that only returns the late cards, an their respectives id and current phase?

6
marcosmelo
7 days ago
caio-osilva
caio-osilvaRegular Participant
asked in API

Consultar registros externos do card

Boa tarde pessoal!Estou com a necessidade de consultar os dados de um card que são originados de uma tabela, onde na criação do card os dados dessa tabela são vinculados.No caso é o cadastro de contatos em que eu preciso pegar o email dessa contato, para ajudar no entendimento tenho o print de como é o card abaixo, onde eu preciso pegar o email campo pessoa no canal, mas se eu consulto o card via GraphQL só tenho o retorno:          "field": {            "help": "",            "description": "",            "id": "pessoa_no_canal",            "index_name": "field_3_connector",            "label": "Pessoa no canal",            "type": "connector"          }  

5
leandro-almeida
Pipefy Staff
12 days ago
brennovn
brennovnParticipating Frequently
asked in API

API (Make/Integromat) > Criar cartão com múltiplas opções no campo

Oi, pessoal. Tudo bem? Estou tentando entender como preencher um campo de múltipla escolha dentro do Pipefy usando o Make/Integromat:  No webhook, que recebe os dados no Make/Integromat, eu recebo um texto que as opções que foram selecionadas (no programa que envia os dados para o Make/Integromat) são separadas por vírgula:  Eu tentei 3 formas até o momento e nenhuma funcionou. São as seguintes:    A última tentativa cria um array e eu tentei, em um segundo momento, varrer o mesmo e atualizar o campo em um outro módulo (um módulo para criar o cartão e outro ódulo para atualizar apenas o campo dificuldade), mas não funciounou porque fica apenas com a i-ésima opção selecionada (no exemplo que eu enviei ficou apenas com a opção “Vender para os interessados”) porque toda vez que atualiza, a opção i-1 é sobreposta pela opção i.Imagino que talvez tenha que usar a chamada genérica e escrever a query, mas não consegui entender como fazer pela documentação.Toda sugestão é valida! Já agradeço pe

2
consultoria24
13 days ago
wf-suchit-gupta
wf-suchit-guptaRegular Participant
asked in API

Getting Start Form details of a card

Hi, I am trying to get Start Form values of a particular card(by id). I can get basic details of the card by using the following query { "query": "{card(id: 595234678) {title done id updated_at }}"}But it does not fetch the start form details (excluding the reason that i have not mentioned its field which i could not find)Can you please help me with a query which queries the start from details of the card as well [email protected] I humbly request you to help me with this.

6
Lais Laudari
Community Manager
1 month ago
vrushil-gajra
vrushil-gajraRegular Participant
asked in API

Error - The request signature we calculated does not match the signature you provided. Check your key and signing method.

Process - Need to upload the signed document from Docusign to pipefy cardfield. For the above process, I am currently using make.com. The article that I am referring is: https://developers.pipefy.com/docs/how-to-upload-attachments-and-attach-to-a-card-record The URL that is being generated in the first stage is showing error “The request signature we calculated does not match the signature you provided. Check your key and signing method.”  Thanks in advance. Any help would be really appreciated!

1
Lais Laudari
Community Manager
1 month ago
SouDescolado
SouDescoladoRegular Participant
asked in API

How to return values of the form?

HelloCurrently I am able to return all card fields by using the following Query:{ "query": "{ phase(id: <ID NUMBER>)  { cards  { edges  { node { id title fields { name value } } } } } }" } However I need to also return the fields from the form attached to each card, as well as their values. Is there any easy way to do that?

6
Lais Laudari
Community Manager
1 month ago
Lais Laudari
Community Manager
Lais LaudariCommunity Manager
published in API

API Errors - Causes and SolutionsF.A.Q.

Here we list some possible errors and solutions that may occur when using the API to perform some action or obtain data: 🔎”Invalid token" errorFor this type of error check the header(s). Two items are required: Authorization and Content-Type. > "Authorization": "Bearer USER_TOKEN",> "Content-Type": "application/json"For the token, the user needs the "longer" token, not the token from the user screen, but the one from https://app.pipefy.com/tokensIt is quite common not to add the Bearer before the token or to add the token with quotes, so just add the Bearer or remove the quotes from the token. Ex: "Barier 'token' " For third party systems like Postman, the correct usage is this one: ​ 🔎Wrong use of linkSometimes the link used can be https://app.pipefy.com/graphiql ou app.pipefy.com/graphiql instead of https://api.pipefy.com/graphql in the header, and this also returns a permission error.  🔎Code problemsFor problems in the code, you can go to the developer > example for page

301
genietim
1 month ago
mattramo
mattramoRegular Participant
asked in API

How can I retrieve a PhaseField value?

Hi Pipefiers,I am currently pulling data through the graphql api of Pipefy. However, I am struggling to retrieve the value of PhaseFields. Starting from a card, this is the nested structure I use Card > current_phase > fields (of type PhaseField) { card(id: "xxxx") { id title pipe { id name } current_phase { fields { index_name index id label description internal_id type options custom_validation help phase { name } } } }}I can retrieve index, options, id, etc… But I cannot identify the field corresponding the the value of the field. Has anyone faced this issue in the past and how did you retrieve the value of a PhaseField?Thanks in advance

2
Lais Laudari
Community Manager
1 month ago
gabrielasil
gabrielasilRegular Participant
asked in API

findCars query doesn't work on specific pipe

Hello everybody. I’m currently having an issue where on a specific pipe, the findCards query returns an empty array of edges, no matter what fieldId and fieldValue I try to use. I don’t think my query is wrong because it returns an error when I pass an invalid fieldId and also it works on a different pipe. Anyone has any idea if I’m missing some pipe configuration or something like that? If it’s important, i’m using Postman to make the requests. query($search: FindCards!, $pipeId: ID!){ findCards(pipeId: $pipeId, search: $search) { edges { node { id, title, fields {name, value} } } pageInfo { endCursor startCursor }}}(GraphQL Variables):{ "search": {"fieldId":"field_id", "fieldValue":"field_value"}, "pipeId": "pipe_id"} 

3
Lais Laudari
Community Manager
2 months ago
loise-franco
Pipefy Staff
loise-francoPipefy Staff
published in API

🔦 New API Reports available!

Hello, Pipefy Community, We have great news: now, you can integrate Pipefy with your reports tool, such as PowerBI or DataStudio, through API! Here’s how: With Reports, you can filter data from your processes in real time, organize them into columns and export them as a spreadsheet to analyze the information you want. If your team needs to export reports frequently and within a certain period of time, you can automate that process! Configure an API Scheduler routine to automate report extraction using a mutation. The report will be exported in the time period you set in your scheduler. To extract the report, two calls are needed, the first is a mutation that will obtain an ID in the response to be used in the extraction, and the second is a query, which will use the response obtained in the first to obtain the download URL of the report. The initial call, as follows, must inform the ID of the Pipe where the report is saved and the ID of the report already formatted with all the columns

70410
vitor-oliveira9
Pipefy Staff
3 months ago
nortonmnobrega
nortonmnobregaNew Participant
asked in API

[API] List All Cards

I wanted to know if I can use the API to list all the cards I have in a pipe to be able to set up an integration.

2
marcos.pedrosa
Pipefy Staff
3 months ago
pedro-soares-kavak
pedro-soares-kavakRegular Participant
asked in API

Cards importer taking to long (more than 7 hours)

Hello Everyone, how are you?I am trying to make a cardImporter request, the problem is that this request is taking to long! always sending the same mensage error, “ 'errors': [{'message': "Another data import is already being processed. Please try again once it's finished.”I send the request yesterday and is still runningSomeone know how to stop a request of being processed?Thanks!  

4
pedro-soares-kavak
3 months ago
nich-morgan
nich-morganRegular Participant
asked in API

Card importer don't generate webhook card.create event

When I create a card with start form, it’s generate a card.create event and sent it to my webhook. But when I create cards with card importer that event don’t be generated.

8
natalia-manffre
Pipefy Staff
4 months ago
rafa15
rafa15Known Participant
asked in API

Problem with GraphQl endpoint User

Hello, we are using this object (https://api-docs.pipefy.com/reference/objects/User/)  in you api but we are getting a user from pipefy's CSM team a#####@pipefy.com So we pay for this user? I believe that she appears in the response because she gives us some support on our pipefy organization. How can I identify that this user is from pipefy and not my org?  

3
marcos.pedrosa
Pipefy Staff
4 months ago
Danielle Diehl
Pipefy Staff
Danielle DiehlPipefy Staff
published in API

🔗 Get the Public Phase Form link from the Public API to integrate with external tools

Hello everyone 👋🏻 I’m excited to announce that now you can get the Public Phase Form link and use that to integrate with other tools, using our API! 🆕 What’s new? We have now a new mutation, called configurePublicPhaseFormLink , you need to pass the cardID and: You will be able to define if the link is enabled or not enabled; You will be able to get the link itself.  💎 Why is it valuable? With this new mutation, you can set a deadline for a Phase Form to be available, and after that specific time/rule, the link will be deactivated. This can be done, using an integration with Workato, for example: This is very important for the procurement process, for example, where suppliers have a certain deadline to send proposals, with that they can ensure everyone has the same deadline; Important for the HR process as well, where HR recruiters can define a specific deadline to get documents, or results from a test; Or any other process where a deadline is required! You

2828
Ezequiel Souza
5 months ago
Keto-Faster
Keto-FasterKnown Participant
asked in API

Get Connected Cards from a Known Pipe

Background:We have cards from Pipe A that have connected fields pointing to Pipe B (cards) We need to find all connected cards for Pipe A from lookups for Pipe BWhich Would be Best Method To Do ThisI am looking at this GraphQL API approach as the possible best route.https://api-docs.pipefy.com/reference/objects/CardRelationship/Using a search via Pipe ID (Pipe A’s ID) would this retrieve a list of all cards that are connected to Pipe B?New to GraphQL so may be misunderstanding this/ there may be a much better approach/ simpler.

5
Keto-Faster
5 months ago
P
pferrariogRegular Participant
asked in API

How to remove someone from an org

Im trying to remove people from an org using graphql syntax with this code: mutation RemoveUserFromPipe {  removeUserFromOrg(    input: {organization_id: "", email: ""}  ) {    success    clientMutationId  }} i’m not very sure thats right, some of you guys can help me with it? 

5
Juliana Spinardi
Community Manager
5 months ago
Keto-Faster
Keto-FasterKnown Participant
asked in API

Error on Adding Data to Long Text Field

Pipefy is rejecting a card creation based on the update for a long text field. The error doesn’t give me a lot to go on. Appreciate any thoughts on this. ERROR FROM PIPEFY:RuntimeErrorError Parse error on "7" (INT) at [1, 553] Text added to Long text field TEAM CE - Optimize KPI - Volume Mgt - Total Ticket Pool Size Dropped Below 50 Your data has met the Alert Conditions: less than 50.0 Week Ticket Created At matches "last 7 days" Report: INPUT: Ticket Pool Size - Total New Tickets by Request Date ( https://eu.holistics.io/dashboards/2199023262493-ce-team/?_e=2199023280138 ) Dashboard: CE Team ( https://eu.holistics.io/dashboards/2199023262493-ce-team ) Here are the records that meet the Alert conditions: (Max 100 rows of results) Week Ticket Created At 2022-09-19 00:00:00.000000 34

3
Keto-Faster
5 months ago
gabriel-silva-seteloc
gabriel-silva-setelocNew Participant
asked in API

API integration

I want to send an email whenever a card is moved. However, the email will be sent through another website. Therefore, I need to integrate via api, to search for the "email" field of the request and inform the site to send the email. How do I do that? I don't know GraphQl. I need a step-by-step guide for beginners.

1
Lais Laudari
Community Manager
5 months ago
jon71
jon71Regular Participant
asked in API

Getting current phase link through API

I’m trying to get the current phase link to a card through the show card API request. I need to be able to automate getting this link to the cards phase form but can’t find a way.This is the link generated from within the card. Does anyone know if this follows any logic or if its random? It looks like it contains a uuid but it doesn’t match the card or phase.I know you can get this link through email but I need to be able to get it externally please let me know if you have a work around Thanks

4
Juliana Spinardi
Community Manager
5 months ago
Luan Moraes
Luan MoraesRegular Participant
posted in API

Search results in table

I'm performing a search in the data table, but I can't filter a specific field;Ex: { table_records(table_id: "xxxxxxx") {edges {      node {        record_fields {          name          value         }      }    }  }}I need the value field to return with the variable that I will insert.PSC. I'm using this search through a PHP integration.

3
vitor-oliveira9
Pipefy Staff
6 months ago
L
leandro.silvaNew Participant
asked in API

Update Label Webhook - Card Header

When the label update is done directly in the card header. Does pipefy send any card update webhook?

1
denise-hipolito
Pipefy Staff
6 months ago

Community Experts Leaderboard

Terms & ConditionsCookie settings