EventNotification

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "EventNotification",
  "type": "object",
  "description": "Configuration for envelope event notifications via DocuSign Connect webhooks.",
  "properties": {
    "url": {
      "type": "string",
      "description": "The webhook endpoint URL to receive notifications."
    },
    "loggingEnabled": {
      "type": "string",
      "description": "When true, Connect logging is enabled."
    },
    "requireAcknowledgment": {
      "type": "string",
      "description": "When true, requires HTTPS 200 acknowledgment."
    },
    "envelopeEvents": {
      "type": "array",
      "description": "Envelope-level events to trigger notifications."
    },
    "recipientEvents": {
      "type": "array",
      "description": "Recipient-level events to trigger notifications."
    },
    "includeCertificateOfCompletion": {
      "type": "string",
      "description": "When true, includes the certificate of completion."
    },
    "includeDocuments": {
      "type": "string",
      "description": "When true, includes document PDFs in the notification."
    },
    "includeDocumentFields": {
      "type": "string",
      "description": "When true, includes document custom fields."
    },
    "includeHMAC": {
      "type": "string",
      "description": "When true, includes HMAC security headers."
    },
    "includeSenderAccountAsCustomField": {
      "type": "string"
    },
    "includeTimeZone": {
      "type": "string",
      "description": "When true, includes time zone information."
    },
    "includeCertificateWithSoap": {
      "type": "string"
    }
  }
}