{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/autodesk/json-schema/autodesk-modify-hook-payload-schema.json",
  "title": "ModifyHookPayload",
  "description": "Specifies the details of a webhook to be updated. ",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/autodesk-aps-webhooks-openapi.yml#/components/schemas/ModifyHookPayload",
  "type": "object",
  "properties": {
    "status": {
      "$ref": "#/$defs/StatusUpdate"
    },
    "autoReactivateHook": {
      "type": "boolean",
      "description": "``true`` - Automatically reactivate the webhook if it becomes ``inactive``.\n\n``false`` - (Default) Do not reactivate the webhook if it becomes ``inactive``.\n\nSee [Event Delivery Guarantees](/en/docs/webhooks/v1/developers_guide/event-delivery-guarantees/) for more information on how the webhooks service handles reactivation."
    },
    "filter": {
      "type": [
        "string",
        "null"
      ],
      "description": "A Jsonpath expression that you can use to filter the callbacks you receive.\n\nSee [Callback Filtering](/en/docs/webhooks/v1/developers_guide/callback-filtering/) for more information."
    },
    "hookAttribute": {
      "type": [
        "object",
        "null"
      ],
      "description": "A JSON object for storing user-defined custom information. The maximum size of this object must be less than 1KB.",
      "additionalProperties": true
    },
    "token": {
      "type": "string",
      "description": "A secret token that is used to generate a hash signature, which is passed along with notification requests to the callback URL.\n\nSee the [Secret Token](/en/docs/webhooks/v1/developers_guide/basics/#secret-token) section in API Basics for more information."
    },
    "hookExpiry": {
      "type": [
        "string",
        "null"
      ],
      "description": "The date and time the webhook will expire, formatted as an ISO 8601 date/time string. If you set this to null, the webhook will never expire."
    }
  },
  "$defs": {
    "StatusUpdate": {
      "type": "string",
      "description": "Sets the current state of the webhook. Possible values:\n\n- ``active`` - Activates webhook.\n- ``inactive`` - Deactivates webhook.\n",
      "enum": [
        "active",
        "inactive"
      ]
    }
  }
}