API Integration
If you use a custom app or web ordering tool, you can connect it to CleanCloud POS through CleanCloud’s API. This API also supports custom reporting and hardware integrations.
📌 Note: If you’re using CleanCloud’s own pickup and delivery apps, the API is not required, as orders sync automatically.
For detailed guidance, refer to our API documentation at cleancloudapp.com/api.
Grow and Grow+ customers can access their API keys under Settings → Admin → Pickup and Delivery → API.
Increasing API Limit
CleanCloud’s API allows 50,000 requests monthly, with a max of 3 requests per second. Additional bundles of 25,000 requests per month are available at $15.00 (USD/GBP/EUR) each.
To monitor API requests, go to Settings → Admin → Pickup and Delivery → API Usage.
💬 For API limit increases, please reach out to our Support Team.
Webhooks
Webhooks enable immediate updates to external systems whenever key events occur in CleanCloud. They’re ideal for syncing with external marketing or pickup tools.
CleanCloud currently offers 10 webhooks for the following events:
order.created (In Store Orders)order.created (Pickup and Delivery Orders)order.status_changedorder.pickup_rescheduledorder.delivery_rescheduledorder.nothing_to_pickuporder.deletedcustomer.createdcustomer.updatedcustomer.deleted
To set up, go to Settings → Admin → Pickup and Delivery → API → Webhooks, add your Webhook URL, and choose the events you want to trigger.
🧪 Testing Tip: The easiest way to test your webhooks is to use https://webhook.site. It instantly gives you a unique URL where you can view incoming webhook requests in real time. Once you’re confident everything is working, you can swap it out for your own endpoint and custom code.
Frequently Asked Questions
Q: Who can access the API and Webhooks?
A: API and Webhooks are available exclusively to Grow and Grow+ customers. Customers in Mexico can also access the API on the Pro plan. If you’re on a different plan, consider upgrading for access.
Q: How do I retrieve data or link orders to customers using the API?
A: You can use endpoints like:
api/getCustomer— to retrieve customer data.api/getOrders— to retrieve order data.
In thegetOrdersresponse, each order includes both anid(order ID) andcustomerID(customer ID), making it easy to link orders to customers.
Q: How does it work for multiple stores?
A: Each store has its own unique API key. When working across multiple locations, use the API key specific to the store you’re querying.
Q: How can I test my Webhooks before going live?
A: Use webhook.site to test your payloads. It provides a real-time log of requests sent to the provided URL. Once you’re confident, replace the testing URL with your production endpoint.
Q: Do you offer support for API and Webhook integration?
A: CleanCloud does not offer direct support for developing or troubleshooting custom API or Webhook integrations. Please refer to the API documentation or work with a third-party developer.
🛟 Need more help?
CleanCloud doesn’t offer support for Webhooks and API. If you need more help, please check out the API documentation or reach out to a third-party developer.