How the Integration Works
Each partner is registered with a base URL, webhook path and API key; vGrubs calls your endpoints as events occur.
Each partner is registered in the vGrubs system with the following configuration:
| Parameter | Description |
|---|---|
| Base URL | The root URL of your REST API (e.g. https://api.yourplatform.com) |
| Webhook path | The path vGrubs defines and exposes for receiving new orders from you (e.g. /partner/orders/{partner-name}) |
| API Key | A shared key used to authenticate requests in both directions |
Once registered, vGrubs will begin calling your endpoints as events occur on our side. Your responsibility is to implement those endpoints and ensure they conform to the contracts defined in this documentation.
The sandbox base URL is
https://sandbox.vgrubs.com. The production URL is provided by vGrubs once the integration is fully tested and ready to go live.