API

Pipefy API

  • 68 Topics
  • 195 Replies

68 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. 

3842
Marcos Carvalho
Pipefy Staff
11 months 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
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
12 days 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
25 days 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
2 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
2 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
2 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
2 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
4 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
4 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
4 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
4 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
4 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
4 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
4 months ago
alexander-razumeiko
alexander-razumeikoRegular Participant
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
4 months ago
Paulo Seze - Midwest Eng.
Paulo Seze - Midwest Eng.Regular Participant
asked in API

Integração Workato

Olá!Estou tentando obter acesso a Workato, mas até o momento não consegui.Alguém poderia me dar uma dica de como consigo fazer o cadastro?

3
denise-hipolito
Pipefy Staff
4 months ago
Keto-Faster
Keto-FasterKnown Participant
asked in API

Creating Cards with Labels via API

I’m having trouble creating a card via the API where the card has a label.Have received a variety of errors, looking like this:Error 30000 Invalid input: priority_1 (["Urgent"])It doesn’t accept the Label Name that you see in Pipefy.Am I missing something about the format that should be used for a label?This is the documentation:https://api-docs.pipefy.com/reference/objects/LabelField/

2
Keto-Faster
4 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
J
johnsigmaNew Participant
asked in API

Criar card com campos via GraphQlL

Boa tarde. Sou novo no uso do Pipefy e da linguagem GraphQL e estou com dificuldades em criar cards com campos personalizados.Primeiramente criei os campos de fase que preciso (createPhaseField), mas quando uso a mutation createCard a API me retorna um erro.Minha mutation:mutation { createCard(input:{ pipe_id: xxxx phase_id: xxxxx title: "Teste" fields_attributes: [ {field_id:"nome_completo", field_value: "John Cunha"} {field_id:"telefone_1", field_value: "xxxxxx"} {field_id:"email_1", field_value: "[email protected]"} {field_id:"data_de_nascimento", field_value: "01/06/2000"} {field_id:"profiss_o", field_value: "Dentista"} {field_id:"produto", field_value: "xxxxx"} ] }){ card { id title } }} Erro retornado:{ "data": { "createCard": null }, "errors": [ { "message": "Invalid inputs: O campo \" Nome Completo do Lead\" é obrigatório, por favor preencha-o!, O campo \" Email do

1
Karine Cristina
Pipefy Staff
5 months ago
fabiorosa
fabiorosaNew Participant
asked in API

Create card with labes - using API

In the form there is the Label field with the value "test" as shown in the image below: when I create GraphQL and pass the input label I can't register, here's the image:   Follow my configured form  

1
julia-pinheiro
Pipefy Staff
5 months ago
rogerpitigliani
rogerpitiglianiRegular Participant
asked in API

Graphql - Add Card Attachment

Hello! Is it possible add attachments to specific Card using Graphql?I can update Card… add comments.. but I could not add attachments.. :(If possible, could you give an example… Thanks...  

5
rogerpitigliani
6 months ago
nsbrown
nsbrownRegular Participant
asked in API

Creating a card with an option field via api

Hey, So I can create a card which works fine via Javascript, the issue I’m facing is populating the radio field. Here’s my code:const query = `mutation { createCard(input: { pipe_id:302543188, title: "New card 2", fields_attributes:[ {field_id: "options", value: "Yes"}, ], }) { card { title } } }` The field in question has a name “Options” with a yes and no option. Any help would be great.

2
nsbrown
7 months ago
mauricio-rodrigues2
mauricio-rodrigues2Regular Participant
asked in API

Extract all activities from the card

Hello,Please, could someone tell me if the Pipefy API can extract all activities data from a card?Example:The user moved from Inbox to Making;The user moved from Done to PeersI need to have the life of the card, entrances and exits of the phases in an accumulative way.Example:Card created at 20:00The user moved from Inbox to Making at 21:00The user moved from Making to Inbox (again); 21:30And so on ...

3
Lucas Democh
7 months ago
zevi
zeviRegular Participant
asked in API

pipefy api

Hi I'm trying to use the pipefy API and every time I send the request the response I get is                Access to XMLHttpRequest at 'https://api.pipefy.com/' from origin 'https://www.mywebsite.com' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header is present on the requested resource.I would appreciate if you could take your time to help me thanks 

3
genietim
7 months ago

Community Experts Leaderboard

Terms & ConditionsCookie settings