Webhooks send instant updates about customers and orders to an external endpoint whenever key events happen in CleanCloud. Use them to keep a marketing tool, a pickup tool, or your own system up to date. Webhooks are available on the Grow and Grow+ plans.
Go to More > Store Settings > Developer > Webhooks to set them up.
How to set up a webhook
Go to More > Store Settings > Developer > Webhooks.
Enter your endpoint in Webhook URL.
Under Send Webhook Events, toggle on each event you want to receive.
Your changes save as you make them.
Events you can send
CleanCloud offers 10 webhook events:
order.created (In Store Orders): an in-store order is created.
order.created (Pickup and Delivery Orders): a pickup and delivery order is created.
order.status_changed: an order moves to a new status.
order.pickup_rescheduled: a pickup gets a new date or time.
order.delivery_rescheduled: a delivery gets a new date or time.
order.nothing_to_pickup: a driver marks a pickup as nothing to collect.
order.deleted: an order is deleted.
customer.created: a new customer is added.
customer.updated: a customer’s details change.
customer.deleted: a customer is deleted.
Tip: Your endpoint should respond quickly. If you have heavy processing to do, accept the webhook, return a 200 response straight away, and process the data in the background.
How to test your webhooks
The easiest way to test is with webhook.site, a free tool from another company. It gives you a unique URL and shows each request in real time.
Open webhook.site and copy your unique URL.
Paste it into Webhook URL in CleanCloud.
Toggle on the events you want to test.
Create or change an order or customer in CleanCloud, and check the request on webhook.site.
When it works, replace the test URL with your own endpoint.
Common questions
Who can use webhooks?
Who can use webhooks?
Customers on the Grow and Grow+ plans.
Can I send webhooks to more than one URL?
Can I send webhooks to more than one URL?
No. You can add one Webhook URL.
Does it work for multiple stores?
Does it work for multiple stores?
Each store has its own webhook settings and its own API key.
Does CleanCloud Support help build integrations?
Does CleanCloud Support help build integrations?
CleanCloud does not offer direct support for developing or troubleshooting custom API or webhook integrations. Use the API documentation or work with a third-party developer.