Update a webhook
Make changes to the configuration of the webhook identified in the path. The request contains the new values you want to have in the webhook configuration. The response contains the full configuration for the webhook, which includes the new values from the request.
To make this request, your API credential must have the following roles:
- Management API—Webhooks read and write
In: header
Path Parameters
The unique identifier of the merchant account.
Unique identifier of the webhook configuration.
Request Body
application/json
Indicates if expired SSL certificates are accepted. Default value: false.
Indicates if self-signed SSL certificates are accepted. Default value: false.
Indicates if untrusted SSL certificates are accepted. Default value: false.
Indicates if the webhook configuration is active. The field must be true for us to send webhooks about events related an account.
Additional shopper and transaction information to be included in your standard webhooks. Find out more about the available additional settings.
Format or protocol for receiving webhooks. Possible values:
- soap
- http
- json
Value in
- "http"
- "json"
- "soap"
Your description for this webhook configuration.
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.
Value in
- "HTTP"
- "TLSv1.2"
- "TLSv1.3"
Network type for Terminal API notification webhooks. Possible values:
- public
- local
Default Value: public.
Value in
- "local"
- "public"
Password to access the webhook URL.
Indicates if the SOAP action header needs to be populated. Default value: false.
Only applies if communicationFormat: soap.
Public URL where webhooks will be sent, for example https://www.domain.com/webhook-endpoint.
Username to access the webhook URL.
length <= 255Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/merchants/string/webhooks/string" \ -H "Content-Type: application/json" \ -d '{ "active": true }'Example response for activating a webhook configuration.
{ "id": "S2-3E5E42476641", "type": "standard", "url": "YOUR_WEBHOOK_URL", "description": "Webhook for YOUR_MERCHANT_ACCOUNT - YOUR_MERCHANT_CODE", "username": "", "hasPassword": false, "active": true, "hasError": false, "communicationFormat": "json", "acceptsExpiredCertificate": false, "acceptsSelfSignedCertificate": false, "acceptsUntrustedRootCertificate": false, "populateSoapActionHeader": false, "additionalSettings": { "properties": { "includePosTerminalInfo": false, "includeARN": false, "includePosDetails": false, "includeCardInfoForRecurringContractNotification": false, "includeRiskData": false, "includeRiskExperimentReference": false, "includeSoapSecurityHeader": false, "includeContactlessWalletTokenInformation": false, "includeAcquirerReference": false, "includeRiskProfileReference": false, "includeOriginalMerchantReferenceCancelOrRefundNotification": false, "includeNfcTokenInformation": false, "includeSubvariant": false, "includeThreeDSVersion": false, "includeInstallmentsInfo": false, "includeAliasInfo": false, "includeShopperCountry": false, "includeRawThreeDSecureResult": false, "includeAirlineData": false, "includeGrossCurrencyChargebackDetails": false, "includeThreeDSecureResult": false, "includeMetadataIn3DSecurePaymentNotification": false, "includeOriginalReferenceForChargebackReversed": false, "addAcquirerResult": false, "includeDeliveryAddress": false, "includeRetryAttempts": false, "includeExtraCosts": false, "includeCardHolderName": false, "includeShopperDetail": false, "includeBankAccountDetails": false, "includeMandateDetails": false, "includeAuthAmountForDynamicZeroAuth": false, "includeIssuerCountry": false, "includeAcquirerErrorDetails": false, "includeCoBrandedWith": false, "includeShopperInteraction": false, "includeDeviceAndBrowserInfo": false, "addRawAcquirerResult": false, "includeCardBin": false, "includeFundingSource": false, "includeThreeDS2ChallengeInformation": false, "includeRiskProfile": false, "includeRealtimeAccountUpdaterStatus": false, "includeDunningProjectData": false, "includePaymentResultInOrderClosedNotification": false, "includeCardBinDetails": false, "includeNotesInManualReviewNotifications": false, "includeZeroAuthFlag": false, "addCaptureReferenceToDisputeNotification": false, "includePayPalDetails": false, "includeRawThreeDSecureDetailsResult": false, "includeBankVerificationResults": false, "includeCaptureDelayHours": false, "addPaymentAccountReference": false, "includePayULatamDetails": false, "includeStore": false, "returnAvsData": false, "includeWeChatPayOpenid": false, "includeUpiVpa": false, "includeUpiMetadata": false, "includeCustomRoutingFlagging": false, "includeTokenisedPaymentMetaData": false } }, "_links": { "self": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641" }, "generateHmac": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/generateHmac" }, "merchant": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT" }, "testWebhook": { "href": "https://management-test.adyen.com/v1/merchants/YOUR_MERCHANT_ACCOUNT/webhooks/S2-3E5E42476641/test" } }}Get a webhook GET
Returns the configuration for the webhook identified in the path. To make this request, your API credential must have one of the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read * Management API—Webhooks read and write
Remove a webhook DELETE
Remove the configuration for the webhook identified in the path. To make this request, your API credential must have the following [roles](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write