List all webhooks

get/companies/{companyId}/webhooks

API Version

Lists all webhook configurations for the company account.

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

Management API—Webhooks read
Management API—Webhooks read and write

Endpoint destination URL

https://management-test.adyen.com/v3/companies/{companyId}/webhooks

Query Parameters

Required

Optional

The number of items to have on a page, maximum 100. The default is 10 items on a page.

The number of the page to fetch.

Path Parameters

Required

Optional

Unique identifier of the company account.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
_linksobject
Pagination references.
firstobject
The first page.
hrefstring
lastobject
The last page.
hrefstring
nextobject
The next page. Only present if there is a next page.
hrefstring
prevobject
The previous page. Only present if there is a previous page.
hrefstring
selfobject
The current page.
hrefstring
accountReferencestring
Reference to the account.
dataarray[object]
The list of webhooks configured for this account.
_linksobject
References to resources connected with this webhook.
companyobject
The company account that the webhook is configured for. Only present for company-level webhooks.
hrefstring
generateHmacobject
Generate an HMAC key.
hrefstring
merchantobject
The merchant account that the webhook is configured for. Only present for merchant-level webhooks.
hrefstring
selfobject
Link to the resource itself.
hrefstring
testWebhookobject
Test the webhook setup.
hrefstring
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
Indicates if the webhook configuration is active. The field must be true for you to receive webhooks about events related an account.
additionalSettingsobject
Additional shopper and transaction information to be included in your standard notifications. Find out more about the available additional settings.
excludeEventCodesarray[string]
Object containing list of event codes for which the notification will not be sent.
includeEventCodesarray[string]
Object containing list of event codes for which the notification will be sent.
propertiesobject
Object containing boolean key-value pairs. The key can be any standard webhook additional setting, and the value indicates if the setting is enabled. For example, captureDelayHours: true means the standard notifications you get will contain the number of hours remaining until the payment will be captured.
certificateAliasstring
The alias of our SSL certificate. When you receive a notification from us, the alias from the HMAC signature will match this alias.
communicationFormatstring
Format or protocol for receiving webhooks. Possible values:

soap

http

json

descriptionstring
Your description for this webhook configuration.
encryptionProtocolstring
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.
filterMerchantAccountTypestring
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.

filterMerchantAccountsarray[string]
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.
networkTypestring
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
The type of webhook. Possible values are:

standard

account-settings-notification

banktransfer-notification

boletobancario-notification

directdebit-notification

ach-notification-of-change-notification

pending-notification

ideal-notification

ideal-pending-notification

report-notification

terminal-api-notification

terminal-settings

terminal-boarding

Find out more about standard notification webhooks and other types of notifications.
urlstring
Public URL where webhooks will be sent, for example https://www.domain.com/webhook-endpoint.
usernamestring
Username to access the webhook URL.
itemsTotalinteger
Total number of items.
pagesTotalinteger
Total number of pages.
400 - Bad Request
A problem reading or understanding the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
401 - Unauthorized
Authentication required.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
403 - Forbidden
Insufficient permissions to process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
422 - Unprocessable Entity
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.
500 - Internal Server Error
The server could not process the request.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
A code that identifies the problem type.
instancestring
A unique URI that identifies the specific occurrence of the problem.
invalidFieldsarray[object]
Detailed explanation of each validation error, when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
A unique reference for the request, essentially the same as pspReference.
responseobject
JSON response payload.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the problem type, pointing to human-readable documentation on this problem type.

List all webhooks

HTTP Responses

200 - OK

400 - Bad Request

401 - Unauthorized

403 - Forbidden

422 - Unprocessable Entity

500 - Internal Server Error