ADadyen
Webhooks - merchant level

Set up a webhook

Subscribe to receive webhook notifications about events related to your merchant account. You can add basic authentication to make sure the data is secure.

To make this request, your API credential must have the following roles:

  • Management API—Webhooks read and write
post/merchants/{merchantId}/webhooks

Request

  • Base URL
    https://management-test.adyen.com/v3
  • URL
    https://management-test.adyen.com/v3/merchants/{merchantId}/webhooks
  • Auth
    • HTTP basic
    • or API key in header X-API-Key

Path parameters

merchantIdstring required

The unique identifier of the merchant account.

Request body

acceptsExpiredCertificateboolean

Indicates if expired SSL certificates are accepted. Default value: false.

acceptsSelfSignedCertificateboolean

Indicates if self-signed SSL certificates are accepted. Default value: false.

acceptsUntrustedRootCertificateboolean

Indicates if untrusted SSL certificates are accepted. Default value: false.

activeboolean required

Indicates if the webhook configuration is active. The field must be true for us to send webhooks about events related an account.

communicationFormat'http' | 'json' | 'soap' required

Format or protocol for receiving webhooks. Possible values:

  • soap
  • http
  • json
descriptionstring

Your description for this webhook configuration.

encryptionProtocol'HTTP' | 'TLSv1.2' | 'TLSv1.3'

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 will use sslVersion: TLSv1.2.

networkType'local' | 'public'

Network type for Terminal API notification webhooks. Possible values:

  • public
  • local

Default Value: public.

passwordstring

Password to access the webhook URL.

populateSoapActionHeaderboolean

Indicates if the SOAP action header needs to be populated. Default value: false.

Only applies if communicationFormat: soap.

typestring required

The type of webhook that is being created. Possible values are:

  • standard
  • account-settings-notification
  • banktransfer-notification
  • boletobancario-notification
  • directdebit-notification
  • ach-notification-of-change-notification
  • direct-debit-notice-of-change-notification
  • pending-notification
  • ideal-notification
  • ideal-pending-notification
  • report-notification
  • rreq-notification
  • terminal-settings
  • terminal-boarding

Find out more about standard webhooks and other types of webhooks.

urlstring required

Public URL where webhooks will be sent, for example https://www.domain.com/webhook-endpoint.

usernamestring

Username to access the webhook URL.

Example request

{
  "communicationFormat": "soap",
  "encryptionProtocol": "TLSv1.2",
  "url": "http://www.adyen.com"
}

Response

OK - the request has succeeded.

acceptsExpiredCertificateboolean

Indicates if expired SSL certificates are accepted. Default value: false.

acceptsSelfSignedCertificateboolean

Indicates if self-signed SSL certificates are accepted. Default value: false.

acceptsUntrustedRootCertificateboolean

Indicates if untrusted SSL certificates are accepted. Default value: false.

accountReferencestring

Reference to the account the webook is set on.

activeboolean required

Indicates if the webhook configuration is active. The field must be true for you to receive webhooks about events related an account.

certificateAliasstring

The alias of our SSL certificate. When you receive a notification from us, the alias from the HMAC signature will match this alias.

communicationFormat'http' | 'json' | 'soap' required

Format or protocol for receiving webhooks. Possible values:

  • soap
  • http
  • json
descriptionstring

Your description for this webhook configuration.

encryptionProtocol'HTTP' | 'TLSv1.2' | 'TLSv1.3'

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 will use sslVersion: TLSv1.2.

filterMerchantAccountType'allAccounts' | 'excludeAccounts' | 'includeAccounts'

Shows how merchant accounts are included in company-level webhooks. Possible values:

  • includeAccounts
  • excludeAccounts
  • allAccounts: Includes all merchant accounts, and does not require specifying filterMerchantAccounts.
filterMerchantAccountsstring[]

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 filterMerchantAccountType is either:

  • includeAccounts
  • excludeAccounts

Not needed for filterMerchantAccountType: allAccounts.

hasErrorboolean

Indicates if the webhook configuration has errors that need troubleshooting. If the value is true, troubleshoot the configuration using the testing endpoint.

hasPasswordboolean

Indicates if the webhook is password protected.

hmacKeyCheckValuestring

The checksum of the HMAC key generated for this webhook. You can use this value to uniquely identify the HMAC key configured for this webhook.

idstring

Unique identifier for this webhook.

networkType'local' | 'public'

Network type for Terminal API details webhooks.

populateSoapActionHeaderboolean

Indicates if the SOAP action header needs to be populated. Default value: false.

Only applies if communicationFormat: soap.

typestring required

The type of webhook. Possible values are:

  • standard
  • account-settings-notification
  • banktransfer-notification
  • boletobancario-notification
  • directdebit-notification
  • ach-notification-of-change-notification
  • direct-debit-notice-of-change-notification
  • pending-notification
  • ideal-notification
  • ideal-pending-notification
  • report-notification
  • terminal-api-notification
  • terminal-settings
  • terminal-boarding

Find out more about standard webhooks and other types of webhooks.

urlstring required

Public URL where webhooks will be sent, for example https://www.domain.com/webhook-endpoint.

usernamestring

Username to access the webhook URL.

Example response

{
  "communicationFormat": "soap",
  "encryptionProtocol": "TLSv1.2",
  "url": "http://www.adyen.com"
}

Changes

No recorded changes to this operation across all 50 revisions of this API.