Events

Event-related webhooks

Product Availability Updated

Sent when a product's availability status changes (becomes available or unavailable). This webhook is triggered whenever the product goes out of stock or becomes available again.

Payload

application/vnd.api+json

Responses

200

Webhook received successfully

No content

400

Bad request - invalid webhook payload

500

Internal server error

Payload

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "products",
    "attributes": {
      "isAvailable": false,
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  },
  "meta": {
    "eventType": "product.availability.updated"
  }
}

Order State Updated

Sent when an order's state changes (e.g., from open to paid). This webhook is triggered whenever the state of an order is updated.

Payload

application/vnd.api+json

Responses

200

Webhook received successfully

No content

400

Bad request - invalid webhook payload

500

Internal server error

Payload

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "orders",
    "attributes": {
      "state": "open",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  },
  "meta": {
    "eventType": "order.state.updated"
  }
}

Order Status Updated

Sent when an order's status changes (e.g., from received to delivered). This webhook is triggered whenever the status of an order is updated.

Payload

application/vnd.api+json

Responses

200

Webhook received successfully

No content

400

Bad request - invalid webhook payload

500

Internal server error

Payload

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "orders",
    "attributes": {
      "status": "dispatched",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  },
  "meta": {
    "eventType": "order.status.updated"
  }
}

Order Total Updated

Sent when an order's total changes due to gratuity (tip) or correction amount being added or modified. This webhook is triggered whenever the total of an order is updated after a payment that includes a tip, or when adjustments are applied to the order.

Payload

application/vnd.api+json

Responses

200

Webhook received successfully

No content

400

Bad request - invalid webhook payload

500

Internal server error

Payload

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "orders",
    "attributes": {
      "tipAmount": "5.50",
      "correctionAmount": null,
      "total": "125.50",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  },
  "meta": {
    "eventType": "order.total.updated"
  }
}

Booking Status Updated

Sent when a booking's status changes (e.g., from confirmed to canceled). This webhook is triggered whenever the status of a booking is updated.

Payload

application/vnd.api+json

Responses

200

Webhook received successfully

No content

400

Bad request - invalid webhook payload

500

Internal server error

Payload

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "bookings",
    "attributes": {
      "status": "cancelled",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  },
  "meta": {
    "eventType": "booking.status.updated"
  }
}

Orders Payments Added

Sent when a payment is successfully added to an order. This webhook is triggered whenever a new payment transaction is recorded against an order, allowing you to track payment events in real-time.

Payload

application/vnd.api+json

Responses

200

Webhook received successfully

No content

400

Bad request - invalid webhook payload

500

Internal server error

Payload

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "type": "orders",
    "attributes": {
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "paymentId": "987e6543-e21b-45d3-a789-426614174999",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  },
  "meta": {
    "eventType": "orders.payments.added"
  }
}