API Integration
If you have a separate app or web ordering tool, you can integrate it with CleanCloud POS using CleanCloud's API. The API can also be used for custom reporting and hardware integration.
If you are using CleanCloud's pickup and delivery apps, the API isn't required as orders automatically sync with your CleanCloud account.
For detailed instructions, access the API documentation at cleancloudapp.com/api.
Grow and Grow+ customers can find their API keys in Settings → Admin → Pickup and Delivery → API.
Increasing API Limit
The API allows 50,000 requests per month, with a maximum of 5 requests per second. CleanCloud offers additional API bundles for purchase. Each group of 25,000 requests per month costs $15.00 (USD/GBP/EUR).
Monitor your API requests in Settings → Admin → Pickup and Delivery → API Usage.
💬 Contact the Support Team if you need to increase the API limit for your account.
Webhooks
Webhooks are ideal for sending immediate updates about customers or orders to an external API endpoint. This is useful for integrating external marketing or pickup tools that require up-to-date information.
CleanCloud offers 8 webhooks, pinging an external URL for the following events:
order.created (In Store Orders)order.created (Pickup and Delivery Orders)order.status_changedorder.pickup_rescheduledorder.delivery_rescheduledorder.deletedcustomer.createdcustomer.updated
Navigate to Settings → Admin → Pickup and Delivery → API → Webhooks to add your Webhook URL and select the events you want to trigger.
⚡ API & Webhook support is exclusively available for Grow and Grow+ customers. Upgrade your plan today to access these and other powerful features.
💡 Need more help?
Explore our Help Center articles for answers. Contact us for further assistance.