Skip to main content
All CollectionsPickup & DeliveryAPI and Advanced Features
Integrating with CleanCloud API and Webhooks
Integrating with CleanCloud API and Webhooks

Learn how to integrate custom apps with CleanCloud using API and webhooks for efficient order management and real-time updates.

Rafael avatar
Written by Rafael
Updated over a month ago

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 9 webhooks for the following events:

  • order.created (In Store Orders)

  • order.created (Pickup and Delivery Orders)

  • order.status_changed

  • order.pickup_rescheduled

  • order.delivery_rescheduled

  • order.nothing_to_pickup

  • order.deleted

  • customer.created

  • customer.updated

To set up, go to Settings → Admin → Pickup and Delivery → API → Webhooks, add your Webhook URL, and choose the events you want to trigger.


⚡ API & Webhook support is available exclusively to Grow and Grow+ customers. Consider upgrading your plan for access to these powerful features.


🛟 Need more help?

Explore our Help Center articles for answers. Contact us for further assistance.

Did this answer your question?