👤 For super admins and admins
🔐 Available on all plans
🎯 For those who want to integrate Pipefy’s processes with other tools
⏩ Content Summary:
If your company's processes depend on additional tools beyond Pipefy, you can count on our API to optimize your workflow. You can build your own integrations between these systems and use them to make requests directly to Pipefy.
It’s a low-code feature, so you’ll need basic knowledge about the topic to learn how to use this feature.
If this is your first experience with APIs, we recommend taking our basicAPI and Integrations online free course. We also have more content about this subject at Pipefy Developers and in our Community.
What is an API?
API is an acronym for Application Programming Interface. It works as a connection between software or computers to simplify programming, making a more secure connection since an API only shows the information and actions essential to development.
The Pipefy API can be used for integrations with custom or third-party systems, as long as they have a public API.
💡 Tip: Pipefy's API can integrate internal or third-party systems if they have a public API; that API must accept CORS (Cross-Origin Resource Sharing) requests. This mechanism allows a website to access resources from others, even those with different domains. Learn more about CORs.
What is it for?
In general terms, APIs help users avoid doing twice the work. You can use it to:
Transfer information from one software system to another
Automate tasks in mass, such as creating cards and updating or deleting data
Edit fields within cards
Create and edit registers in your database
GraphQL
GraphQL is a data query and manipulation language for APIs created by Facebook. This is also the name given to the back-end that provides information in GraphQL format. You can use it with other programming languages, like Node, Ruby, or Python.
In GraphQL, you can use queries to consult information and mutations to alter data in the API.
🔎 Here is an introduction to Pipefy's GraphQL endpoints.
🔎 And here are references about queries, mutations, and more!
Access
To use Pipefy’s API, you have two options: using our Integrated Development Environment (IDE) or making requests to our endpoint:
Public IDE or GraphQL playground: use these to help with commands. Mutations and any changes made in this area will reflect in your pipe. Note that you can’t create automations or robots in it. In this IDE, it isn’t necessary to set up an authorization code because this process is already synced with the user authentication in Pipefy.
Endpoint: You can use this to make requests from our API, and build custom integrations that best fit your needs.
Authentication
For Pipefy GraphQL authentication, you need an OAuth2 Bearer token. There are two forms of authentication in GraphQL.
The most recommended is Service Accounts for production environments due to their security and organization management. The other is a Personal Access Token, ideal for users who will test the API or make calls to their own pipes.
To find out how to obtain your Service Account key and its step-by-step instructions, click here. If you choose to use the Personal Access Token, follow these steps:
Click Generate new token
Give the token a description
Click Save
Check on the token whenever it is needed to authenticate it on Pipefy
🔔 Attention: Only admin or super admin users can use Pipefy's API. Learn more about roles and permissions in Pipefy.
API call limits
Each Pipefy plan has a different limit of API calls per month:
Starter plan: up to 20 API calls per month
Business plan: up to 500 API calls per month
Enterprise plan: up to 10,000 API calls per month
Unlimited: customized API call limit
An API call is a request sent to the server requesting a response containing certain information. For example: search for cards with a specific title within a specific pipe.
Request limits
The number of subsequent queries allowed per unit of time is 500 requests every 30 seconds. If the limit is exceeded, the user will not be able to request the API for 5 minutes.
The number of webhook configurations is based on the process's size and depends on the organization's subscription. We recommend not including more than 30 webhooks in any pipe, but this can vary.
Inputs and outputs are primarily based on the size of your process, using predefined queries and mutations. In general, each request returns only 50 records, requiring the use of paging.
The size limit for attached files is 512MB for each file.
For security reasons, the generated file links are only available for 15 minutes.
Related Content
🎓 Learn how to do more with less with free Pipefy Academy courses!
🌎 Join the Pipefy Community to ask questions, share ideas, stay tuned, and showcase your knowledge with professionals from around the globe!