{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/autodesk/json-schema/autodesk-created-hooks-schema.json",
  "title": "CreatedHooks",
  "description": "Contains the response to a Create Webhooks for All Events request.",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/autodesk-aps-webhooks-openapi.yml#/components/schemas/CreatedHooks",
  "type": "object",
  "properties": {
    "hooks": {
      "type": "array",
      "uniqueItems": true,
      "minItems": 1,
      "description": "An array of objects, where each object represents a webhook that was created.",
      "items": {
        "$ref": "#/$defs/HookDetails"
      }
    }
  },
  "$defs": {
    "HookDetails": {
      "description": "Contains the details of a webhook.",
      "type": "object",
      "title": "HookDetails",
      "properties": {
        "hookId": {
          "type": "string",
          "minLength": 1,
          "description": "The ID that uniquely identifies the webhook."
        },
        "tenant": {
          "type": "string",
          "minLength": 1,
          "description": "The ID of the tenant from which the event\noriginates."
        },
        "callbackUrl": {
          "type": "string",
          "minLength": 1,
          "description": "The URL to send notifications to when the\nevent is triggered."
        },
        "createdBy": {
          "type": "string",
          "minLength": 1,
          "description": "The ID of the entity that created the webhook. It can be one of the following:\n\n- Client ID of an app: If created using a Client Credentials flow (two-legged OAuth).\n- User ID of a user: If created using an Authorization Code flow (three-legged OAuth)."
        },
        "event": {
          "type": "string",
          "minLength": 1,
          "description": "The event type the webhook subscribes to. See [Supported Events](/en/docs/webhooks/v1/reference/events/) for a full list of events and wildcard patterns."
        },
        "createdDate": {
          "type": "string",
          "minLength": 1,
          "description": "The date and time when the webhook was created, formatted as an ISO 8601 date/time string."
        },
        "lastUpdatedDate": {
          "type": "string",
          "minLength": 1,
          "description": "The date and time when the webhook was last modified, formatted as an ISO 8601 date/time string."
        },
        "system": {
          "type": "string",
          "minLength": 1,
          "description": "The ID of the system the webhook applies to. For example ``data`` for Data Management. See [Supported Events](/en/docs/webhooks/v1/reference/events/) for a full list of systems."
        },
        "creatorType": {
          "type": "string",
          "minLength": 1,
          "description": "Indicates what type of an entity created the webhooks. Possible values:\n\n- ``O2User`` - Created by a user through an Authorization Code flow (three-legged OAuth).\n- ``Application`` - Created by an application using a Client Credentials flow (two-legged OAuth)."
        },
        "status": {
          "$ref": "#/$defs/Status"
        },
        "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."
        },
        "hookExpiry": {
          "type": [
            "string",
            "null"
          ],
          "description": "The date and time when the webhook will expire, formatted as an ISO 8601 date/time string. A missing or null value indicates that the webhook will never expire.\n\n``hookExpiry`` is returned only if it was specified when the webhook was created."
        },
        "hookAttribute": {
          "type": "object",
          "description": "A JSON object for storing user-defined custom information. The maximum size of this object is less than 1KB.",
          "additionalProperties": true
        },
        "scope": {
          "type": "object",
          "description": "Specifies the extent to which the event is monitored. For example, if the scope is set to ``folder``, the webhooks service will generate notifications for the specified event occurring in that folder and any subfolders or contained items.",
          "properties": {
            "folder": {
              "type": "string",
              "minLength": 1,
              "description": "The URN of the folder the scope is set to. Present only for Data Management events.\n\nSee [Creating a Webhook and Listening to Data Management Events](/en/docs/webhooks/v1/tutorials/create-a-hook-data-management/) for more information."
            },
            "workflow": {
              "type": "string",
              "description": "The ID of a Model Derivative workflow the scope is set to. Present only for Model Derivative events.\n\nSee [Creating a Webhook and Listening to Model Derivative Events](/en/docs/webhooks/v1/tutorials/create-a-hook-model-derivative/) for more information.\n"
            }
          }
        },
        "hubId": {
          "type": "string",
          "description": "The ID of the hub that contains the entity monitored by this webhook. This attribute is returned only if it was specified during the webhook's creation.\n\nFor BIM 360, a Data Management Hub ID corresponds to an Account ID. For Forma, a Data Management Hub ID corresponds to a Forma Hub ID. To convert either to a Data Management Hub ID, prefix the ID with ``b.`` For example, a BIM 360 Account ID or Forma Hub ID of ``c8b0c73d-3ae9`` translates to a Data Management Hub ID of ``b.c8b0c73d-3ae9``."
        },
        "projectId": {
          "type": "string",
          "description": "The ID of the project that contains the entity monitored by this webhook. This attribute is returned only if it was specified during the webhook's creation.\n\nBIM 360 and Forma project IDs are different from Data Management project IDs. To convert BIM 360 or Forma Project IDs to Data Management Project IDs, prefix them with ``b.`` For example, a Project ID of ``c8b0c73d-3ae9`` becomes ``b.c8b0c73d-3ae9``."
        },
        "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."
        },
        "urn": {
          "type": "string",
          "minLength": 1,
          "description": "The URN of the webhook."
        },
        "__self__": {
          "type": "string",
          "minLength": 1,
          "description": "A link to itself."
        }
      }
    },
    "Status": {
      "type": "string",
      "enum": [
        "active",
        "inactive",
        "reactivated"
      ],
      "description": "Indicates the current state of the webhook. Possible values are\n\n- ``active`` - Successfully delivered most recent event notifications.\n- ``inactive`` - Failed to deliver most recent event notification and has been deactivated.\n- ``reactivated`` - Previously inactive webhook that has been reactivated. No events have occurred since reactivation.\n\nSee [Event Delivery Guarantees](/en/docs/webhooks/v1/developers_guide/event-delivery-guarantees/) for more information on how the system deactivates webhooks and subsequently reactivates them.\n"
    }
  }
}