API

Pipefy API

  • 68 Topics
  • 195 Replies

68 Topics

joaogalhardo
joaogalhardoInspiring
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}}     }    

3
joaogalhardo
1 year ago
Juliana Spinardi
Community Manager
Juliana SpinardiCommunity Manager
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

19562
genietim
1 year ago
tsartori
tsartoriSuperuser
asked in API

Pipefy -> PowerBI Integration

English Hello, I am trying to connect Pipefy and PBI, with the power Query and a GraphQL API, but i cant find the right URL to put in. It keep me returning the error 400 or 404.May someone help me? Português Olá,Estou tentando conectar o Pipefy e o PowerBI através do Power Query e uma API de GraphQL, porém as URLs sempre dão erro 404 ou 400.Alguém sabe me ajudar?

13
murilova
11 months ago
Juliana Spinardi
Community Manager
Juliana SpinardiCommunity Manager
published in API

New GraphQL API update: Batch field updates for Cards and Database Records

We released a new API mutation called updateFieldsValues that will allow users to update up to 30 fields in a single API call. This new mutation will improve the overall developer experience when handling batch updates and will significantly improve the speed of batch updates, by reducing the number of API calls. 📌 Incremental updatesThis new API mutation also allows developers to update fields that contain multiple data by just adding a new value or removing an existing value.For example, to add a label to a label field, previously developers would need to do two API calls, an API call to get all existing labels, use this list to append the new label and then send to Pipefy in another API call the new list of all the labels. With the new mutation updateFieldsValues, developers can send an API mutation telling Pipefy to only add a new label to the existing list of labels in a​ field, the same applies to assignees, connections and checklists fields. Sample GraphQL mutationUpdating two

8256
camila-borges1
9 months 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
1 year ago
vitoria36
vitoria36Regular Participant
asked in API

Get all records from a table

Hi!I'm trying to get all records from a table, but using table_records isn't giving me all of them.Running the following code in Python I get 50 records, but my table has 94. Any ideas of how I can get all of them?import requestsimport jsonpayload = {"query": "{ table_records(table_id:\"TABLE_ID\") {edges {node {id }}}}"}headers = { "authorization": f"Bearer {pipefy_token}", "content-type": "application/json"}response = requests.request("POST", url, json=payload, headers=headers)json_data = json.loads(response.text)print(len(json_data["data"]["table_records"]["edges"])) 

2
william-kliemann
1 year ago
ramongb
ramongbRegular Participant
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
11 months ago
avalizei
avalizeiNew Participant
asked in API

Failed when trying to upload a file from Graphql

Hello,I'm trying to send a file to a card. Executing createPresignedUrl and PUT for S3 works perfectly, I can even access the download of the file that was sent.My problem is with the updateFieldsValues mutation. When I send it I get an error, can you help me with that? My mutation:mutation { updateFieldsValues( input: { nodeId: CARD-ID, values: { fieldId: "foto_do_cnpj_cpf", value: ["uploads/7c3b7885-16d5-44c0-9e23-8570f261b20a/1633126573430.png"], operation: ADD } } ) { clientMutationId, updatedNode }} The returned error: { "data": { "updateFieldsValues": null }, "errors": [ { "message": "Invalid input: foto_do_cnpj_cpf ([\"uploads/7c3b7885-16d5-44c0-9e23-8570f261b20a/1633126573430.png\"])", "locations": [ { "line": 3, "column": 7 } ], "path": [ "updateFieldsValues" ], "code": 30000, "type": "PipefyRuntimeError" } ]} Do you know what it can be? I'

9
kalchenko-a
4 months ago
rdavidsc
rdavidscRegular Participant
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?  

2
rdavidsc
1 year 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
4 months ago
login7
login7New Participant
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",

3
Marcos Carvalho
Pipefy Staff
1 year ago
jon71
jon71Regular 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?

5
genietim
1 year 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.

2
Nicole Chiroli
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

3943
Grafeno
11 months 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. 

3842
Marcos Carvalho
Pipefy Staff
11 months 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 } }} 

4
Roberto Chavarria
Pipefy Staff
1 year ago
bernardo-costa
bernardo-costaRegular Participant
asked in API

What fields can be used on allCards query AdvancedSearch?

Hi guys, I’ve looked up the documentation but couldn’t find anything specifying which fields are allowed at the AdvancedSearch option for the allCards query. Could you please list them here and/or append to the documentation? ThanksBernardo

2
bernardo-costa
1 year ago
rafael-pitanga
rafael-pitangaRegular Participant
asked in API

How do I get and insert data to a table via Postman?

Hi all, How can I find a simple example of how to search table data and to insert data into a custom table with columns like: “Title”, “First Name”, “Last Name” and “E-mail”. I am trying that using Postman, but the only response I got was Bad Request. Is there any link or tutorial explaining how to achieve that? Thanks! 

3
genietim
7 months ago
Carlos Basques
Carlos BasquesRegular Participant
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.

2
Carlos Basques
1 year 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

2
apoluyanov
1 year 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

2
genietim
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!  

2040
Marcos Carvalho
Pipefy Staff
11 months 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
1 year ago
matt171
matt171Regular Participant
asked in API

Access user activity history through GraphQL

It would be great is we could see which users moved a ticket into a phase via the GraphQL API.At present we can see information regarding a phase movement via phases_history in the API but not who undertook this action. This would be extremely useful for auditing and training purposes. The activity history appears to present this information via the UI. Thanks

1
genietim
1 year ago
dawid-szemborowski
dawid-szemborowskiParticipating Frequently
posted in API

createPresignedUrl returns ReadableStream

Hello, I’m trying to upload files using api (application/pdf), and I have several problems but focus on current. I’m making an api call using graphql api as it is said there, but my response.body is always ReadableStream and when I tried to read that stream a got the Uint8Array. Am I doing something wrong or it is what it sould be and I just can’t figure out how to get that url

12
dawid-szemborowski
1 year ago

Community Experts Leaderboard

Terms & ConditionsCookie settings