Management Webhook Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/management-webhook-structure.json",
  "description": "Webhook schema from Adyen API",
  "type": "object",
  "properties": {
    "_links": {
      "description": "References to resources connected with this webhook.",
      "$ref": "#/components/schemas/WebhookLinks"
    },
    "acceptsExpiredCertificate": {
      "description": "Indicates if expired SSL certificates are accepted. Default value: **false**.",
      "type": "boolean"
    },
    "acceptsSelfSignedCertificate": {
      "description": "Indicates if self-signed SSL certificates are accepted. Default value: **false**.",
      "type": "boolean"
    },
    "acceptsUntrustedRootCertificate": {
      "description": "Indicates if untrusted SSL certificates are accepted. Default value: **false**.",
      "type": "boolean"
    },
    "accountReference": {
      "description": "Reference to the account the webook is set on.",
      "type": "string"
    },
    "active": {
      "description": "Indicates if the webhook configuration is active. The field must be **true** for you to receive webhooks about events related an account.",
      "type": "boolean"
    },
    "additionalSettings": {
      "description": "Additional shopper and transaction information to be included in your [standard notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes). Find out more about the available [additional settings](https://docs.adyen.com/development-resources/webhooks/additional-settings).",
      "$ref": "#/components/schemas/AdditionalSettingsResponse"
    },
    "certificateAlias": {
      "description": "The alias of our SSL certificate. When you receive a notification from us, the alias from the HMAC signature will match this alias.",
      "type": "string"
    },
    "communicationFormat": {
      "description": "Format or protocol for receiving webhooks. Possible values:\n* **soap**\n* **http**\n* **json** ",
      "enum": [
        "http",
        "json",
        "soap"
      ],
      "example": "soap",
      "type": "string"
    },
    "description": {
      "description": "Your description for this webhook configuration.",
      "type": "string"
    },
    "encryptionProtocol": {
      "x-addedInVersion": "2",
      "description": "SSL version to access the public webhook URL specified in the `url` field. Possible values:\n* **TLSv1.3**\n* **TLSv1.2**\n* **HTTP** - Only allowed on Test environment.\n\nIf not specified, the webhook will use `sslVersion`: **TLSv1.2**.",
      "enum": [
        "HTTP",
        "TLSv1.2",
        "TLSv1.3"
      ],
      "example": "TLSv1.2",
      "type": "string"
    },
    "filterMerchantAccountType": {
      "description": "Shows how merchant accounts are included in company-level webhooks. Possible values:\n* **includeAccounts**\n* **excludeAccounts**\n* **allAccounts**: Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`.",
      "enum": [
        "allAccounts",
        "excludeAccounts",
        "includeAccounts"
      ],
      "type": "string"
    },
    "filterMerchantAccounts": {
      "description": "A list of merchant account names that are included or excluded from receiving the webhook. Inclusion or exclusion is based on the value defined for `filterMerchantAccountType`.\n\nRequired if `filterMerchantAccountType` is either:\n* **includeAccounts**\n* **excludeAccounts**\n\nNot needed for `filterMerchantAccountType`: **allAccounts**.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "hasError": {
      "description": "Indicates if the webhook configuration has errors that need troubleshooting. If the value is **true**, troubleshoot the configuration using the [testing endpoint](https://docs.adyen.com/api-explorer/#/ManagementService/v1/post/companies/{companyId}/webhooks/{webhookid}/test).",
      "type": "boolean"
    },
    "hasPassword": {
      "description": "Indicates if the webhook is password protected.",
      "type": "boolean"
    },
    "hmacKeyCheckValue": {
      "description": "The [checksum](https://en.wikipedia.org/wiki/Key_checksum_value) of the HMAC key generated for this webhook. You can use this value to uniquely identify the HMAC key configured for this webhook.",
      "type": "string"
    },
    "id": {
      "description": "Unique identifier for this webhook.",
      "type": "string"
    },
    "networkType": {
      "description": "Network type for Terminal API details webhooks.",
      "enum": [
        "local",
        "public"
      ],
      "type": "string"
    },
    "populateSoapActionHeader": {
      "description": "Indicates if the SOAP action header needs to be populated. Default value: **false**.\n\nOnly applies if `communicationFormat`: **soap**.",
      "type": "boolean"
    },
    "type": {
      "description": "The type of webhook. Possible values are:\n\n- **standard**\n- **account-settings-notification**\n- **banktransfer-notification**\n- **boletobancario-notification**\n- **directdebit-notification**\n- **ach-notification-of-change-notification**\n- **pending-notification**\n- **ideal-notification**\n- **ideal-pending-notification**\n- **report-notification**\n- **terminal-api-notification**\n\nFind out more about [standard notification webhooks](https://docs.adyen.com/development-resources/webhooks/understand-notifications#event-codes) and [other types of notifications](https://docs.adyen.com/development-resources/webhooks/understand-notifications#other-notifications).",
      "type": "string"
    },
    "url": {
      "description": "Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**.",
      "example": "http://www.adyen.com",
      "type": "string"
    },
    "username": {
      "description": "Username to access the webhook URL.",
      "type": "string"
    }
  },
  "required": [
    "type",
    "url",
    "active",
    "communicationFormat"
  ],
  "name": "Webhook"
}