Autodesk · Schema

Hook

Fortune 10003D ModelingArchitectureBIMCADConstructionDesignDigital TwinsEngineeringManufacturingMedia and EntertainmentSustainability

Properties

Name Type Description
hookId string Unique hook identifier.
tenant string The tenant (application client ID).
callbackUrl string URL that receives webhook callbacks.
createdBy string
event string The event type.
createdDate string
lastUpdatedDate string
system string The event system.
creatorType string Creator type (Application or User).
status string
autoReactivateHook boolean Whether to auto-reactivate after failures.
scope object Scope of the webhook (e.g., which folder or project to watch).
urn string
filter string JSON-encoded filter criteria for narrowing events.
View JSON Schema on GitHub

JSON Schema

autodesk-hook-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Hook",
  "title": "Hook",
  "type": "object",
  "properties": {
    "hookId": {
      "type": "string",
      "description": "Unique hook identifier."
    },
    "tenant": {
      "type": "string",
      "description": "The tenant (application client ID)."
    },
    "callbackUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL that receives webhook callbacks."
    },
    "createdBy": {
      "type": "string"
    },
    "event": {
      "type": "string",
      "description": "The event type."
    },
    "createdDate": {
      "type": "string",
      "format": "date-time"
    },
    "lastUpdatedDate": {
      "type": "string",
      "format": "date-time"
    },
    "system": {
      "type": "string",
      "description": "The event system."
    },
    "creatorType": {
      "type": "string",
      "description": "Creator type (Application or User).",
      "enum": [
        "Application",
        "O2User"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "inactive"
      ]
    },
    "autoReactivateHook": {
      "type": "boolean",
      "description": "Whether to auto-reactivate after failures."
    },
    "scope": {
      "type": "object",
      "description": "Scope of the webhook (e.g., which folder or project to watch).",
      "properties": {
        "folder": {
          "type": "string"
        },
        "workflow": {
          "type": "string"
        }
      }
    },
    "urn": {
      "type": "string"
    },
    "filter": {
      "type": "string",
      "description": "JSON-encoded filter criteria for narrowing events."
    }
  }
}