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

Test a webhook

POST
/companies/{companyId}/webhooks/{webhookId}/test

Sends sample notifications to test if the webhook is set up correctly.

We send sample notifications for maximum 20 of the merchant accounts that the webhook is configured for. If the webhook is configured for more than 20 merchant accounts, use the merchantIds array to specify a subset of the merchant accounts for which to send test notifications.

We send four test notifications for each event code you choose. They cover success and failure scenarios for the hard-coded currencies EUR and GBP, regardless of the currencies configured in the merchant accounts. For custom notifications, we only send the specified custom notification.

The response describes the result of the test. The status field tells you if the test was successful or not. You can use the other response fields to troubleshoot unsuccessful tests.

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

merchantIds?array<string>

List of merchantId values for which test webhooks will be sent. The list can have a maximum of 20 merchantId values.

If not specified, we send sample notifications to all the merchant accounts that the webhook is configured for. If this is more than 20 merchant accounts, use this list to specify a subset of the merchant accounts for which to send test notifications.

notification?

Custom test notification object. Required when the types list contains CUSTOM.

types?array<string>

List of event codes for which to send test notifications. Only the webhook types below are supported.

Possible values if webhook type: standard:

  • AUTHORISATION
  • CHARGEBACK_REVERSED
  • ORDER_CLOSED
  • ORDER_OPENED
  • PAIDOUT_REVERSED
  • PAYOUT_THIRDPARTY
  • REFUNDED_REVERSED
  • REFUND_WITH_DATA
  • REPORT_AVAILABLE
  • CUSTOM - set your custom notification fields in the notification object.

Possible values if webhook type: banktransfer-notification:

  • PENDING

Possible values if webhook type: report-notification:

  • REPORT_AVAILABLE

Possible values if webhook type: ideal-notification:

  • AUTHORISATION

Possible values if webhook type: pending-notification:

  • PENDING

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/companies/string/webhooks/string/test" \  -H "Content-Type: application/json" \  -d '{    "merchantIds": [      "YOUR_MERCHANT_ACCOUNT"    ],    "types": [      "AUTHORISATION"    ]  }'

Example response for testing a webhook event.

{  "data": [    {      "merchantId": "YOUR_MERCHANT_ACCOUNT_AU",      "output": "",      "requestSent": "{\"live\":\"false\",\"notificationItems\":[{\"NotificationRequestItem\":{\"amount\":{\"currency\":\"EUR\",\"value\":100},\"eventCode\":\"AUTHORISATION\",\"eventDate\":\"2022-05-10T16:57:19+02:00\",\"merchantAccountCode\":\"YOUR_MERCHANT_ACCOUNT_AU\",\"merchantReference\":\"6GZBF5ML\",\"operations\":[\"CANCEL\",\"CAPTURE\",\"REFUND\"],\"paymentMethod\":\"visa\",\"pspReference\":\"KDN7UP7S1JIK6XES\",\"reason\":\"\",\"success\":\"true\"}}]}",      "responseCode": "200",      "responseTime": "657 ms",      "status": "success"    }  ]}

Generate an HMAC key POST

Returns an [HMAC key](https://en.wikipedia.org/wiki/HMAC) for the webhook identified in the path. This key allows you to check the integrity and the origin of the notifications you receive.By creating an HMAC key, you start receiving [HMAC-signed notifications](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures#enable-hmac-signatures) from Adyen. Find out more about how to [verify HMAC signatures](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures). 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

List all webhooks GET

Lists all webhook configurations for the merchant account. > This call does not return webhook configurations for the company account to which the specified merchant account belongs. You can see these in your Customer Area under **Developers** > **Webhooks**. 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