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
In: header
Path Parameters
Unique identifier of the company account.
Unique identifier of the webhook configuration.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/companies/string/webhooks/string"Example response for getting a webhook configuration.
{ "id": "S2-4A3B33202A46", "type": "standard", "url": "YOUR_WEBHOOK_URL", "description": "Webhook for YOUR_COMPANY_ACCOUNT - YOUR_COMPANY_CODE", "filterMerchantAccountType": "allAccounts", "username": "adyen", "hasPassword": true, "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" } }}Set up a webhook POST
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](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write
Update a webhook PATCH
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](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Webhooks read and write