| _links |
object |
References to resources connected with this webhook. |
| 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**. |
| accountReference |
string |
Reference to the account the webook is set on. |
| active |
boolean |
Indicates if the webhook configuration is active. The field must be **true** for you to receive 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 |
| certificateAlias |
string |
The alias of our SSL certificate. When you receive a notification from us, the alias from the HMAC signature will match this alias. |
| 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 included in company-level webhooks. Possible values: * **includeAccounts** * **excludeAccounts** * **allAccounts**: Includes all merchant accounts, and does not require |
| 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 |
| hasError |
boolean |
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/# |
| hasPassword |
boolean |
Indicates if the webhook is password protected. |
| hmacKeyCheckValue |
string |
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. |
| id |
string |
Unique identifier for this webhook. |
| networkType |
string |
Network type for Terminal API details webhooks. |
| 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. Possible values are: - **standard** - **account-settings-notification** - **banktransfer-notification** - **boletobancario-notification** - **directdebit-notification** - **ach-no |
| 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. |