Test Webhooks

Before going live, you can create test orders to test your Order Events and Rider Events webhooks. Test orders will generate relevant events, allowing you to validate your webhook endpoints.

To create a test order, you must use a separate API endpoint: Create Test Order.

Test orders will not appear on Deliveroo tablets and will not assign any real riders.

In this mode, the server will perform webhook callbacks based on durations provided in the test_webhooks field in the request object.

To use the Create Test Order endpoint, you must use your test credentials. Please follow our Basic Authentication (Test) guide for details on authenticating with your test credentials. You will be using your test API key as the username and your test API secret as the password.

📘

You do not need to accept/reject these test orders via Deliveroo's Update Order Status endpoint or send a sync status.

Simulating Events

You will specify when to deliver each event as durations as you create a test order. For example:

"test_webhooks": {
  "new": "10s",
  "accepted": "15s",
  "rider_assigned": "20s",
  "rider_arrived": "1m",
  "rider_confirmed_at_restaurant": "1m5s",
  "rider_unassigned": "1m30s"
}

With the configuration above, you will receive the order.new event 10 seconds after creating the test order.

After another 5 seconds (15 seconds in total), you will receive the order.status_update event with the status set to "accepted".

Deliveroo will similarly send you all the events defined in the test_webhook object.

🚧

Remember to use a different webhook URL than your production one. Otherwise, you will receive test orders in your production environment.

❗️

Testing Legacy POS Webhooks is Unsupported

You can create test orders to test Order Events and Rider Events webhooks. POS (Legacy) Webhook is not supported.