WebhookEndpointResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/docupanda/json-schema/docupanda-webhook-endpoint-response-schema.json",
  "title": "WebhookEndpointResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/docupanda-webhook-api-openapi.yml#/components/schemas/WebhookEndpointResponse",
  "properties": {
    "endpointId": {
      "type": "string",
      "title": "Endpointid",
      "description": "The ID which identifies the webhook endpoint"
    },
    "url": {
      "type": "string",
      "title": "Url",
      "description": "The URL which receives webhook events"
    },
    "description": {
      "type": "string",
      "title": "Description",
      "description": "The webhook endpoint description"
    },
    "subscribedEvents": {
      "items": {
        "$ref": "#/$defs/EventTypeEnum"
      },
      "type": "array",
      "title": "Subscribedevents",
      "description": "The events sent to this endpoint. If not specified, all events are sent"
    },
    "disabled": {
      "type": "boolean",
      "title": "Disabled",
      "description": "Whether delivery to this webhook endpoint is disabled"
    },
    "secret": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Secret",
      "description": "The signing secret for this endpoint, used to verify that a delivered event genuinely came from DocuPipe. Returned when retrieving a single endpoint; omitted when listing endpoints"
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "title": "Createdat",
      "description": "The date and time when the webhook endpoint was created"
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "title": "Updatedat",
      "description": "The date and time when the webhook endpoint was last updated"
    }
  },
  "type": "object",
  "required": [
    "endpointId",
    "url",
    "description",
    "disabled",
    "createdAt",
    "updatedAt"
  ],
  "$defs": {
    "EventTypeEnum": {
      "type": "string",
      "enum": [
        "document.processed.success",
        "document.processed.error",
        "standardization.processed.success",
        "standardization.processed.error",
        "transformation.processed.success",
        "transformation.processed.error",
        "review.processed.success",
        "review.processed.error",
        "review.verified.success",
        "review.rejected.success",
        "schema.processed.success",
        "schema.processed.error",
        "classification.processed.success",
        "classification.processed.error",
        "split.processed.success",
        "split.processed.error",
        "merge.processed.success",
        "merge.processed.error",
        "workflow.processed.success",
        "workflow.processed.error"
      ],
      "title": "EventTypeEnum"
    }
  }
}