Canto · Schema

webhook_properties

Digital Asset ManagementDAMBrand AssetsImagesVideosDocumentsMedia LibraryAsset Distribution

Properties

Name Type Description
id number Webhook ID
url string Webhook URL endpoint (including protocol e.g., https://)
resource string Resource type to monitor
event string Event to monitor (specific to resource)
active boolean Whether webhook is actively sending or disabled
View JSON Schema on GitHub

JSON Schema

canto-webhook-properties.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "webhook_properties",
  "required": [
    "active",
    "event",
    "id",
    "resource",
    "url"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "description": "Webhook ID"
    },
    "url": {
      "type": "string",
      "description": "Webhook URL endpoint (including protocol e.g., https://)"
    },
    "resource": {
      "type": "string",
      "description": "Resource type to monitor",
      "enum": [
        "product",
        "variant",
        "import"
      ]
    },
    "event": {
      "type": "string",
      "description": "Event to monitor (specific to resource)",
      "enum": [
        "created",
        "updated",
        "deleted",
        "started",
        "completed",
        "failed"
      ]
    },
    "active": {
      "type": "boolean",
      "description": "Whether webhook is actively sending or disabled"
    }
  },
  "additionalProperties": false
}