APIMatic Adyen APIs
Sign Up to APIMatic
HomeSDKsAPI ReferenceContext Plugin
ManagementWebhooksWebhooks company level

Update a webhook

PATCH
/companies/{companyId}/webhooks/{webhookId}

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

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

companyId*string

The unique identifier of the company account.

webhookId*string

Unique identifier of the webhook configuration.

Request Body

application/json

acceptsExpiredCertificate?boolean

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

acceptsSelfSignedCertificate?boolean

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

acceptsUntrustedRootCertificate?boolean

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

active?boolean

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

additionalSettings?

Additional shopper and transaction information to be included in your standard webhooks. Find out more about the available additional settings.

communicationFormat?string

Format or protocol for receiving webhooks. Possible values:

  • soap
  • http
  • json

Value in

  • "http"
  • "json"
  • "soap"
description?string

Your description for this webhook configuration.

encryptionProtocol?string

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"
filterMerchantAccountType?string

Shows how merchant accounts are filtered when configuring the webhook. Possible values:

  • 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.
  • allAccounts: Includes all merchant accounts, and does not require specifying filterMerchantAccounts.

Value in

  • "allAccounts"
  • "excludeAccounts"
  • "includeAccounts"
filterMerchantAccounts?array<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.

networkType?string

Network type for Terminal API notification webhooks. Possible values:

  • public
  • local

Default Value: public.

Value in

  • "local"
  • "public"
password?string

Password to access the webhook URL.

populateSoapActionHeader?boolean

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

Only applies if communicationFormat: soap.

url?string

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

username?string

Username to access the webhook URL.

Lengthlength <= 255

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/companies/string/webhooks/string" \  -H "Content-Type: application/json" \  -d '{    "active": true  }'

Example response for activating a webhook configuration.

{  "id": "S2-4A3B33202A46",  "type": "standard",  "url": "YOUR_WEBHOOK_URL",  "description": "Webhook for YOUR_COMPANY_ACCOUNT - YOUR_COMPANY_CODE",  "filterMerchantAccountType": "allAccounts",  "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/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46"    },    "company": {      "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT"    },    "generateHmac": {      "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/generateHmac"    },    "testWebhook": {      "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-4A3B33202A46/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