ManagementWebhooksWebhooks company level

List all webhooks

GET
/companies/{companyId}/webhooks

Lists all webhook configurations for the company account.

To make this request, your API credential must have one of the following roles:

  • Management API—Webhooks read
  • Management API—Webhooks read and write

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

companyId*string

Unique identifier of the company account.

Query Parameters

pageNumber?integer

The number of the page to fetch.

Formatint32
pageSize?integer

The number of items to have on a page, maximum 100. The default is 10 items on a page.

Formatint32

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/companies/string/webhooks"

Example response for getting the list of webhook configurations.

{  "_links": {    "first": {      "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks?pageNumber=1&pageSize=10"    },    "last": {      "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks?pageNumber=1&pageSize=10"    },    "self": {      "href": "https://management-test.adyen.com/v1/companies/YOUR_COMPANY_ACCOUNT/webhooks?pageNumber=1&pageSize=10"    }  },  "itemsTotal": 1,  "pagesTotal": 1,  "data": [    {      "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"        }      }    }  ]}