Add a webhook configuration

POST {{baseUrl}}/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

Request Body

{"type"=>"standard", "url"=>"YOUR_WEBHOOK_URL", "username"=>"YOUR_USER", "password"=>"YOUR_PASSWORD", "active"=>true, "communicationFormat"=>"soap", "acceptsExpiredCertificate"=>false, "acceptsSelfSignedCertificate"=>true, "acceptsUntrustedRootCertificate"=>true, "populateSoapActionHeader"=>false, "filterMerchantAccountType"=>"includeAccounts", "filterMerchantAccounts"=>["{{YOUR_MERCHANT_ACCOUNT}}"]}

HEADERS

RESPONSES

status: OK

{"id":"S2-6933523D2772","type":"standard","url":"YOUR_WEBHOOK_URL","description":"Webhook for YOUR_COMPANY_ACCOUNT - YOUR_COMPANY_CODE","filterMerchantAccountType":"includeAccounts","filterMerchantAccounts":["YOUR_MERCHANT_ACCOUNT"],"username":"myuser","hasPassword":true,"active":true,"hasError":false,"communicationFormat":"soap","acceptsExpiredCertificate":false,"acceptsSelfSignedCertificate":true,"acceptsUntrustedRootCertificate":true,"certificateAlias":"signed-test.adyen.com_2023","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,"includeCustomRoutingFlagging":false,"includeTokenisedPaymentMetaData":false}},"_links":{"self":{"href":"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-6933523D2772"},"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-6933523D2772/generateHmac"},"testWebhook":{"href":"https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks/S2-6933523D2772/test"}}}