Papo's API (https://papo.global/) is a programming interface that allows developers to connect other systems, such as CRMs, ERPs, or automation platforms (like n8n), directly to their Papo account. It serves to automate actions, such as sending WhatsApp messages, querying Extractor contacts, or triggering the platform's artificial intelligence, without needing to use the graphical interface.
The API opens up a range of possibilities to customize and scale your operation, integrating Papo's functionalities into your company's existing workflows. Instead of performing actions manually in the dashboard, your own software can command Papo to execute tasks.
API, Webhooks, and Ready-Made Integrations: What's the Difference?
It's common to confuse these three concepts. The table below summarizes the main difference between them and when to use each.
| Characteristic | API (Application Programming Interface) | Webhooks | Ready-Made Integrations |
|---|---|---|---|
| Direction | Your system requests or sends data to Papo. | Papo sends data to your system. | Papo connects to another service. |
| Action Initiative | Your external system. | The Papo platform. | The user, when configuring in the dashboard. |
| Technical Knowledge | Requires programming or the use of tools like n8n. | Requires an endpoint (URL) in your system to receive data. | Does not require programming, only configuration in the dashboard. |
| Example of Use | Send a WhatsApp message when a purchase is approved in your e-commerce. | Notify your billing system whenever a new contact is created in Papo. | Connect your Google Calendar account so Papo's AI can schedule meetings. |
What is Papo's API Used For?
With the API, you can build custom automations and integrations for your business. Some of the main applications include:
- Send Messages: Initiate conversations or send WhatsApp notifications from your own system (e.g., order confirmation, payment reminder).
- Access Extractor Contacts: Query the list of leads generated by Papo's Extractor and import them into your CRM or marketing tool.
- Manage Instances: Check the status of your WhatsApp connections directly from your backend.
- Utilize Artificial Intelligence: Send text to the AI API and receive a generated response based on the prompt configured in your Papo account, allowing you to use the same intelligence in other contexts.
- Synchronize Data: Keep your contacts, companies, and deals synchronized between Papo and your main CRM.
- Create Custom Dashboards: Extract service and performance data to feed Business Intelligence (BI) dashboards with specific metrics for your operation.
How to Start Using the API
To use the API, you need technical knowledge or to use a visual automation tool that supports REST API calls, such as n8n. The general process is simple:
| Step | Action | Details |
|---|---|---|
| 1. Generate API Keys | Access the Papo dashboard and go to the developer section to create your keys. | You will have a public key (pk_live_...) to identify your account and a secret key (sk_live_...) for authentication. The secret key is displayed only once. |
| 2. Consult the Documentation | Visit the official API documentation to see all available endpoints. | The documentation details the URLs, required parameters, and response formats for each action (send message, list contacts, etc.). |
| 3. Implement the Calls | Write the code in your system or configure the blocks in your automation tool. | Calls are made via HTTPS to the base URL https://app.papo.global/api/v1, sending the secret key in the authorization header. |
| 4. Test the Integration | Perform tests to ensure your system is communicating correctly with Papo. | Verify that messages are sent and data is received as expected. |
Frequently Asked Questions
Do I need to be a programmer to use the API?
Yes, direct use of the API requires programming knowledge. However, automation tools like n8n or Make allow you to connect to the API through a visual interface, without needing to write code, by simply configuring action blocks and entering your keys.
Where can I find my API keys?
API keys can be generated in your Papo account's settings dashboard, in a section dedicated to developers. Remember that the secret key is shown only at the time of its creation. Store it in a secure location, as it cannot be recovered. If lost, you will need to revoke it and create a new one.
What exactly can I do with the API?
You can perform various actions that you would manually do on the platform. The official documentation lists all endpoints, but the main ones are: sending text messages via WhatsApp (/messages), listing extracted contacts (/contacts), listing your WhatsApp connections (/instances), and using Papo's AI engine to generate texts (/ai/v1/complete).
Does using the API incur additional costs?
Access to the API itself does not incur additional costs on your plan. However, the actions you perform through it may consume resources that are charged, such as sending messages via the WhatsApp API or extracting new leads with the Extractor. For details on operational costs, consult the pricing page on the Papo website.
Is Papo's API REST or SOAP?
Papo's API is a modern REST API. It uses standard HTTP methods (GET, POST, etc.) and communicates using the JSON format, which is lightweight and easy to interpret by most programming languages and automation tools.
What's the difference between using the API directly and using a ready-made integration like Google Calendar?
The API offers full flexibility for you to create any type of integration. Ready-made integrations, such as Google Calendar or Wavoip, are pre-built solutions by Papo for common use cases. They are activated with a few clicks, without needing code, but are limited to the functionalities that have been previously developed.
Read also
- How to Integrate Wavoip to Make and Receive Calls in Papo
- Creating Your First Automation Flow from Scratch
Start for free and explore the possibilities →
Connect your channels, configure AI, and start serving customers on the same day.