grubhub · Schema

Grubhub Order Status Webhook Payload

Webhook payload for an order status change event.

Properties

Name Type Description
event_type string The type of event that triggered this webhook.
order_uuid string The unique identifier for the order.
merchant_id string The Grubhub merchant identifier.
previous_status string The previous order status.
new_status string The new order status.
updated_at string When the status was updated.
View JSON Schema on GitHub

JSON Schema

grubhub-orderstatuswebhookpayload-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developer.grubhub.com/schemas/grubhub/orderstatuswebhookpayload.json",
  "title": "Grubhub Order Status Webhook Payload",
  "description": "Webhook payload for an order status change event.",
  "type": "object",
  "properties": {
    "event_type": {
      "type": "string",
      "description": "The type of event that triggered this webhook.",
      "const": "ORDER_STATUS_CHANGE",
      "example": "STANDARD"
    },
    "order_uuid": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier for the order.",
      "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "merchant_id": {
      "type": "string",
      "description": "The Grubhub merchant identifier.",
      "example": "ghm-1234567890"
    },
    "previous_status": {
      "type": "string",
      "description": "The previous order status.",
      "example": "ACTIVE"
    },
    "new_status": {
      "type": "string",
      "description": "The new order status.",
      "enum": [
        "CONFIRMED",
        "IN_PROGRESS",
        "READY",
        "OUT_FOR_DELIVERY",
        "COMPLETED"
      ],
      "example": "CONFIRMED"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the status was updated.",
      "example": "2026-06-02T18:30:00Z"
    }
  }
}