Webhook Response JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "title": "Event Webhook Schema",
  "description": "Schema for webhook events related to orders, invites, vouchers, and beam inputs",
  "required": [
    "id",
    "idType",
    "additionalMetadata",
    "event",
    "eventDate",
    "svixAppId"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the resource for which the event occurred"
    },
    "idType": {
      "type": "string",
      "description": "Type of the resource",
      "enum": [
        "order",
        "invite",
        "beamInput"
      ]
    },
    "additionalMetadata": {
      "type": "object",
      "description": "The same JSON object that was passed when creating the voucher/order",
      "additionalProperties": true
    },
    "event": {
      "type": "string",
      "description": "Name of the event that occurred",
      "enum": [
        "ORDER_STATUS_CHANGE",
        "ORDER_SCORE_CHANGE",
        "VOUCHER_REDEEMED",
        "BEAM_INPUT_CREATED"
      ]
    },
    "eventDate": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 formatted date and time when the event occurred"
    },
    "svixAppId": {
      "type": "string",
      "description": "ID of the Svix App"
    }
  },
  "additionalProperties": false
}