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
Endpoint destination URL
https://management-test.adyen.com/v3/companies/{companyId}/webhooks/{webhookId}/test
Click to copy

Path Parameters

webhookIdstringRequired

Unique identifier of the webhook configuration.

companyIdstringRequired

The unique identifier of the company account.

Request Parameters

merchantIdsarray[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.

notificationobject

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

typesarray[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 parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show moreShow less
  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less