POST /companies/{companyId}/webhooks

Subscribe to receive webhook notifications about events related to your company 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

Servers

https://management-test.adyen.com/v3

Path parameters

Name	Type	Required	Description
`companyId`	String	Yes	Unique identifier of the company account.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`username`	String	No	Username to access the webhook URL.
`description`	String	No	Your description for this webhook configuration.
`url`	String	Yes	Public URL where webhooks will be sent, for example https://www.domain.com/webhook-endpoint.
`networkType`	String	No	Network type for Terminal API notification webhooks. Possible values: public local Default Value: public. Possible values: `"local"` `"public"`
`populateSoapActionHeader`	Boolean	No	Indicates if the SOAP action header needs to be populated. Default value: false. Only applies if `communicationFormat`: soap.
`additionalSettings`	Object	No	Additional shopper and transaction information to be included in your standard notifications. Find out more about the available additional settings.
`additionalSettings.properties`	Object	No	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.
`additionalSettings.includeEventCodes[]`	Array	No	Object containing list of event codes for which the notification will be sent.
`communicationFormat`	String	Yes	Format or protocol for receiving webhooks. Possible values: soap http json Possible values: `"json"` `"soap"` `"http"`
`encryptionProtocol`	String	No	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. Possible values: `"TLSv1.2"` `"TLSv1.3"` `"HTTP"`
`filterMerchantAccountType`	String	Yes	Shows how merchant accounts are filtered when configuring the webhook. Possible values: allAccounts : Includes all merchant accounts, and does not require specifying `filterMerchantAccounts`. includeAccounts : The webhook is configured for the merchant accounts listed in `filterMerchantAccounts`. excludeAccounts : The webhook is not configured for the merchant accounts listed in `filterMerchantAccounts`. Possible values: `"allAccounts"` `"includeAccounts"` `"excludeAccounts"`
`active`	Boolean	Yes	Indicates if the webhook configuration is active. The field must be true for us to send webhooks about events related an account.
`acceptsExpiredCertificate`	Boolean	No	Indicates if expired SSL certificates are accepted. Default value: false.
`filterMerchantAccounts[]`	Array	Yes	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.
`acceptsSelfSignedCertificate`	Boolean	No	Indicates if self-signed SSL certificates are accepted. Default value: false.
`password`	String	No	Password to access the webhook URL.
`type`	String	Yes	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 pending-notification ideal-notification ideal-pending-notification report-notification rreq-notification terminal-settings terminal-boarding Find out more about standard notification webhooks and other types of notifications.
`acceptsUntrustedRootCertificate`	Boolean	No	Indicates if untrusted SSL certificates are accepted. Default value: false.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.