Adyen · Schema
CreateCompanyWebhookRequest
CreateCompanyWebhookRequest schema from Adyen API
PaymentsFinancial ServicesFintech
Properties
| Name | Type | Description |
|---|---|---|
| acceptsExpiredCertificate | boolean | Indicates if expired SSL certificates are accepted. Default value: **false**. |
| acceptsSelfSignedCertificate | boolean | Indicates if self-signed SSL certificates are accepted. Default value: **false**. |
| acceptsUntrustedRootCertificate | boolean | Indicates if untrusted SSL certificates are accepted. Default value: **false**. |
| active | boolean | Indicates if the webhook configuration is active. The field must be **true** for us to send webhooks about events related an account. |
| additionalSettings | object | 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 mor |
| communicationFormat | string | Format or protocol for receiving webhooks. Possible values: * **soap** * **http** * **json** |
| description | string | Your description for this webhook configuration. |
| encryptionProtocol | string | SSL version to access the public webhook URL specified in the `url` field. Possible values: * **TLSv1.3** * **TLSv1.2** * **HTTP** - Only allowed on Test environment. If not specified, the webhook wil |
| filterMerchantAccountType | string | Shows how merchant accounts are filtered when configuring the webhook. Possible values: * **allAccounts** : Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`. * |
| filterMerchantAccounts | array | 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`. Required if `filterMerc |
| networkType | string | Network type for Terminal API notification webhooks. Possible values: * **public** * **local** Default Value: **public**. |
| password | string | Password to access the webhook URL. |
| populateSoapActionHeader | boolean | Indicates if the SOAP action header needs to be populated. Default value: **false**. Only applies if `communicationFormat`: **soap**. |
| type | string | The type of webhook that is being created. Possible values are: - **standard** - **account-settings-notification** - **banktransfer-notification** - **boletobancario-notification** - **directdebit-not |
| url | string | Public URL where webhooks will be sent, for example **https://www.domain.com/webhook-endpoint**. |
| username | string | Username to access the webhook URL. |