{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-webhook-schema.json",
  "title": "Webhook",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ibm-api-connect-webhooks-api-openapi.yml#/components/schemas/Webhook",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "type": {
      "type": "string",
      "readOnly": true,
      "enum": [
        "webhook"
      ]
    },
    "api_version": {
      "type": "string",
      "readOnly": true,
      "enum": [
        "2.0.0"
      ]
    },
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "maxLength": 255
    },
    "title": {
      "type": "string",
      "maxLength": 1023
    },
    "summary": {
      "type": "string",
      "maxLength": 65535
    },
    "scope": {
      "type": "string"
    },
    "state": {
      "type": "string",
      "enum": [
        "online",
        "online_configured",
        "offline_configured",
        "offline_resync",
        "initializing",
        "online_pending",
        "online_throttled"
      ]
    },
    "state_change_reason": {
      "type": "string"
    },
    "state_change_history": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "state_from": {
            "type": "string"
          },
          "state_to": {
            "type": "string"
          },
          "state_change_reason": {
            "type": "string"
          },
          "state_changed_at": {
            "type": "string",
            "format": "date-time"
          }
        }
      }
    },
    "tasks": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "iteration": {
            "type": "string"
          },
          "retry_count": {
            "type": "integer"
          },
          "created_at": {
            "type": "string",
            "format": "date-time"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time"
          },
          "url": {
            "type": "string",
            "format": "uri"
          }
        }
      }
    },
    "endpoint": {
      "type": "string",
      "format": "uri"
    },
    "snapshot_endpoint": {
      "type": "string",
      "format": "uri"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "filter": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "level": {
      "type": "string",
      "enum": [
        "notification",
        "sync"
      ]
    },
    "authorization": {
      "type": "string"
    },
    "secret": {
      "type": "string"
    },
    "tls_client_profile_url": {
      "type": "string",
      "format": "uri"
    },
    "gateway_service_url": {
      "type": "string",
      "format": "uri"
    },
    "portal_service_url": {
      "type": "string",
      "format": "uri"
    },
    "analytics_service_url": {
      "type": "string",
      "format": "uri"
    },
    "state_updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "supported_webhook_features": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "feedback",
          "batch",
          "throttling",
          "api_protection_source",
          "external_oauth_mgmt",
          "policy_visibility",
          "product_replace_v2",
          "product_retire_optimized",
          "global_policy_error",
          "product_migrate_subscriptions",
          "execute_migration_target",
          "event_config_logs",
          "feedback_2",
          "ldap_cxn_pool",
          "open_telemetry",
          "feedback_2_1",
          "sse",
          "feedback_3"
        ]
      }
    },
    "apic_version": {
      "type": "string"
    },
    "available_webhook_features": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "service_version": {
      "type": [
        "string",
        "null"
      ]
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "format": "uri"
    }
  }
}