webhook

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/spendesk/json-schema/spendesk-webhook-schema.json",
  "title": "webhook",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/spendesk-webhooks-api-openapi.yml#/components/schemas/webhook",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "companyId": {
      "type": "string"
    },
    "enabled": {
      "type": "boolean"
    },
    "eventType": {
      "$ref": "#/$defs/webhookEvent"
    },
    "entity": {
      "$ref": "#/$defs/webhookEntity"
    },
    "liveMode": {
      "type": "boolean"
    },
    "version": {
      "type": "integer"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "createdAt": {
      "$ref": "#/$defs/dateTime"
    },
    "updatedAt": {
      "$ref": "#/$defs/dateTime"
    },
    "deletedAt": {
      "oneOf": [
        {
          "$ref": "#/$defs/dateTime"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "id",
    "companyId",
    "enabled",
    "eventType",
    "entity",
    "liveMode",
    "url",
    "version",
    "createdAt",
    "updatedAt"
  ],
  "$defs": {
    "dateTime": {
      "type": "string",
      "format": "date-time",
      "description": "String containing a UTC datetime expressed in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format like `2023-05-12T14:06:40Z`.",
      "title": "dateTime"
    },
    "webhookEntity": {
      "type": "string",
      "enum": [
        "payables",
        "settlements"
      ],
      "title": "webhookEntity"
    },
    "webhookEvent": {
      "type": "string",
      "enum": [
        "created",
        "prepared",
        "updated"
      ],
      "title": "webhookEvent"
    }
  }
}