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

Servers

https://management-test.adyen.com/v3

Path parameters

Name	Type	Required	Description
`webhookId`	String	Yes	Unique identifier of the webhook configuration.
`companyId`	String	Yes	The unique identifier of the company account.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`types[]`	Array	No	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
`notification`	Object	No	Custom test notification object. Required when the `types` list contains CUSTOM.
`notification.paymentMethod`	String	No	The payment method for the payment that the notification is about. Possible values: amex visa mc maestro bcmc paypal sms bankTransfer_NL bankTransfer_DE bankTransfer_BE ideal elv sepadirectdebit
`notification.merchantReference`	String	No	Your reference for the custom test notification.
`notification.amount`	Object	No	The amount of the payment that the notification is about. Set the value in minor units.
`notification.amount.value`	Integer	Yes	The amount of the transaction, in minor units.
`notification.amount.currency`	String	Yes	The three-character ISO currency code.
`notification.eventDate`	String	No	The time of the event. Format: ISO 8601, YYYY-MM-DDThh:mm:ssTZD.
`notification.eventCode`	String	No	The event that caused the notification to be sent.Currently supported values: AUTHORISATION CANCELLATION REFUND CAPTURE REPORT_AVAILABLE CHARGEBACK REQUEST_FOR_INFORMATION NOTIFICATION_OF_CHARGEBACK NOTIFICATIONTEST ORDER_OPENED ORDER_CLOSED CHARGEBACK_REVERSED REFUNDED_REVERSED REFUND_WITH_DATA
`notification.reason`	String	No	A description of what caused the notification.
`notification.success`	Boolean	No	The outcome of the event which the notification is about. Set to either true or false.
`merchantIds[]`	Array	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.