Push a Delivery Job Status Notification
The Push Delivery Job Status Notification API facilitates communication between an external delivery system and Grubtech by delivering real-time updates about delivery job statuses. The external delivery system initiates the API when a delivery job status changes, such as when an order is dispatched, delivered, or canceled.
Examples of Trigger Scenarios:
- A driver accepts a delivery job (status changes to accepted).
- The driver leaves to deliver the order (status changes to dispatched).
- The order is delivered to the customer (status changes to delivered).
The delivery system sends a POST request to the pre-configured webhook URL (https://external_system_webhook).
The API requires an X-API-KEY in the header for authentication, ensuring that only authorized systems can send updates.
Content-Type: application/json specifies that the request body is formatted in JSON. The JSON payload contains the following:
- Delivery job details (delivery_job_id, status, status_updated_at, etc.).
- Driver information (optional but helpful for tracking and communication).
- ETA and additional notes (optional but provides context to the kitchen team).
The request payload must include all required fields in the correct format to avoid errors.
Use to
Inform the Kitchen Team:
The kitchen staff can track delivery progress via an integrated dashboard or alert system.
For example:
- "Driver Alex Smith is on the way to deliver Order #12345."
- "Order #12345 has been delivered."
Improve Customer Communication:
The system can send automated notifications to customers based on delivery job updates (e.g., SMS or email alerts).
Optimize Workflow:
Kitchens can prioritize preparing orders based on the status of delivery jobs.
For more details refer Receive a Delivery Job Status Update API Reference.
Updated 9 days ago