Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-131362831.1 MB
Webhooks - company level

Get a webhook

Returns the configuration for the webhook identified in the path.

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

  • Management API—Webhooks read
  • Management API—Webhooks read and write
get/companies/{companyId}/webhooks/{webhookId}

Path parameters

companyIdstring required

Unique identifier of the company account.

webhookIdstring required

Unique identifier of the webhook configuration.

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.

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.

sslVersion'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.

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",
  "sslVersion": "TLSv1.2",
  "url": "http://www.adyen.com"
}