What You Can Do
- Contacts: Create, search, update, and retrieve contact information, including custom fields.
- Messaging: Fetch conversations or messages, send new ones, and build your own messaging layer powered by Watermelon.
- Webhooks: Set up automated notifications for key events, such as when a new contact is created or a message is received.
Example Use Cases
- Connect your CRM to automatically sync contact and conversation data.
- Build a live dashboard that displays ongoing conversations in real time.
- Trigger external workflows when new messages or contacts appear in Watermelon.
Base URL
The Watermeon API follows REST principles and is accessible only via HTTPS. For security reasons, unencrypted HTTP requests are not allowed. The Base URL for all API endpoints is:Response codes
The API returns standard HTTP response codes to indicate the success or failure of an API request. Here are a few examples:| Code | Description |
|---|---|
200 | Success - The request completed successfully |
400 | Bad Request - The request was malformed or contained invalid parameters |
401 | Unauthorized - Authentication credentials are missing or invalid |
403 | Forbidden - You don’t have permission to access this resource |
404 | Not Found - The requested resource doesn’t exist |
429 | Rate Limited - You’ve exceeded the allowed number of requests |
500 | Server Error - Something went wrong on our end |
Rate limits
To keep performance consistent and ensure fair use, the Watermelon API supports up to 100 concurrent requests per source, with a maximum of 500 requests per minute. Instead of polling for new conversations, messages, or contacts, use webhooks to receive updates instantly as they happen. It’s faster, more reliable, and doesn’t count toward your rate limit.