HookCreateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HookCreateRequest",
  "title": "HookCreateRequest",
  "type": "object",
  "description": "Request body for creating a new webhook subscription.",
  "required": [
    "type",
    "name",
    "endpoint",
    "secret"
  ],
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of entity to watch for changes.",
      "enum": [
        "package",
        "scope",
        "owner"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name of the entity to watch. For packages, use the package name. For scopes, use the scope name (e.g., @myorg). For owners, use the npm username."
    },
    "endpoint": {
      "type": "string",
      "format": "uri",
      "description": "The URI to receive webhook payloads via HTTP POST."
    },
    "secret": {
      "type": "string",
      "description": "A shared secret used to sign webhook payloads. The signature is included in the x-npm-signature header of each delivery."
    }
  }
}