whatsapp inbox api for developers: integration guide

What can developers build with the whatsappx.si API?

Developers can build custom integrations by using the whatsappx.si REST API to interact with their WhatsApp workspace data programmatically. By leveraging API keys and webhooks, you can connect your existing internal tools, databases, or custom software directly to your WhatsApp communication flow.

Since whatsappx.si does not offer built-in CRM integrations, the API serves as the primary bridge for businesses that need to sync WhatsApp messages with external systems. Whether you are looking to log customer interactions into a proprietary database or trigger external events based on incoming messages, the API provides the necessary endpoints to manage your workspace efficiently.

How does authentication work for the API?

Authentication for the whatsappx.si REST API is handled through secure API keys that use Bearer token authentication. When you generate an API key within your workspace settings, you must include this token in the header of your HTTP requests to authorize your application.

This standard approach ensures that only your authorized applications can access or modify your workspace data. Because security is a priority, keep your API keys confidential and rotate them if you suspect they have been compromised. You can find detailed technical specifications and instructions on how to structure your requests at our public documentation.

How do outbound webhooks facilitate real-time data?

Outbound webhooks allow your server to receive instant notifications whenever a new message arrives in your shared inbox. When a message is received, whatsappx.si sends an HTTP POST request to a URL you specify, including the message content and sender details, often protected by a shared-token header for verification.

This functionality is essential for developers who need to build responsive applications. For example, a clinic could set up a webhook to alert their internal scheduling system whenever a patient sends a message, allowing for immediate processing or automated internal logging. By using webhooks, you avoid the need for constant polling, making your integration more efficient and faster.

What are the limitations for developers?

While the API and webhooks offer significant flexibility, it is important to note that whatsappx.si does not provide built-in CRM integrations or pre-built connectors for third-party platforms. You are responsible for building and maintaining the logic that handles the data sent via webhooks or retrieved through the API.

Furthermore, while you can use the API to manage your workspace, you must still adhere to WhatsApp's Business and Commerce Policies. whatsappx.si provides the software layer, but any restrictions or blocks placed on a number by Meta are managed directly between the customer and Meta. You should always ensure that your automated systems respect user opt-ins and do not send messages in bulk, as this can lead to account restrictions.

Where to find technical documentation?

All technical resources, including endpoint descriptions, request formats, and authentication guides, are hosted at our public API documentation. This is the definitive source for developers to understand the capabilities and constraints of the whatsappx.si platform.

We recommend reviewing the documentation thoroughly before starting your integration. If you are looking for general information on how to manage your team or set up your workspace before diving into the code, you can also explore our shared inbox guide or learn about connecting your number via QR code to begin testing your integration in a live environment.