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

Test a webhook

POST
/merchants/{merchantId}/webhooks/{webhookId}/test

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

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 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

merchantId*string

The unique identifier of the merchant account.

webhookId*string

Unique identifier of the webhook configuration.

Request Body

application/json

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/merchants/string/webhooks/string/test" \  -H "Content-Type: application/json" \  -d '{    "types": [      "AUTHORISATION"    ]  }'

Example response for testing a webhook event.

{  "data": [    {      "merchantId": "YOUR_MERCHANT_ACCOUNT",      "output": "",      "requestSent": "{\"live\":\"false\",\"notificationItems\":[{\"NotificationRequestItem\":{\"amount\":{\"currency\":\"EUR\",\"value\":21000},\"eventCode\":\"AUTHORISATION\",\"eventDate\":\"2022-05-10T17:02:03+02:00\",\"merchantAccountCode\":\"YOUR_MERCHANT_ACCOUNT\",\"merchantReference\":\"4TZLD23Y\",\"operations\":[\"CANCEL\",\"CAPTURE\",\"REFUND\"],\"paymentMethod\":\"visa\",\"pspReference\":\"E05WW50L6IOBRGA0\",\"reason\":\"\",\"success\":\"true\"}}]}",      "responseCode": "200",      "responseTime": "532 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

Get all payment methods GET

Returns details for all payment methods of the merchant account identified in the path. To make this request, your API credential must have the following [role](https://docs.adyen.com/development-resources/api-credentials#api-permissions): * Management API—Payment methods read