{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "#/components/schemas/CreateMerchantWebhookRequest", "title": "CreateMerchantWebhookRequest", "properties": { "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" }, "active": { "description": "Indicates if the webhook configuration is active. The field must be **true** for us to send 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/AdditionalSettings" }, "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" }, "networkType": { "description": "Network type for Terminal API notification webhooks. Possible values:\n* **public**\n* **local**\n\nDefault Value: **public**.", "enum": [ "local", "public" ], "type": "string" }, "password": { "description": "Password to access the webhook URL.", "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 that is being created. 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- **rreq-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.", "maxLength": 255, "type": "string" } }, "required": [ "url", "active", "communicationFormat", "type" ], "type": "object" }