Skip to main content

Webhooks

The webhook configuration is needed so Adyen can send Adyen payment status updates to your VTEX account.

For further information, please refer to the Adyen Webhooks documentation.

To configure the webhook, please follow the steps listed below:

  1. Open your Adyen Customer area;
  2. In the left side menu, go to Developers and then Webhooks.
  3. Click on the button “Create new webhook” on the right side of the screen.

Create new webhook

  1. Click on Add for the Standard Webhook section.

Add Standard Webhook

General​

Set a description that helps you to identify the merchant account and VTEX account. In Merchant Accounts field, set “Include only specific merchant accounts”. A new section is going to appear, select the desired merchant account.

General Settings

Server Configuration​

In Server configuration set the URL like this, replacing {{accountName}} with your VTEX account name:

https://{{accountName}}.myvtex.com/_v3/api/webhook/notification

Server Configuration

Security​

Select “No Authentication”.

Security Settings

Events​

Check the following flags: AUTHORISATION / CANCELLATION / CANCEL_OR_REFUND / CAPTURE / CAPTURE_FAILED / MANUAL_REVIEW_REJECT / MANUAL_REVIEW_ACCEPT / OFFER_CLOSED / REFUND / REFUND_FAILED

Events Settings

Additional settings​

Check all flags in every section.

Additional settings

Testing the webhook​

Click on ‘Test configuration’.

Test configuration

Select the merchant account and AUTHORISATION event, then click on ‘Test’.

Select test account and event

Results comparison​

If you receive a ‘200 - OK’ response, your webhook is almost done. If you didn’t receive ‘200 - OK’, it means something is wrong in the configuration. Check all steps again, mainly your webhook URL set in the Server Configuration section.

Success

Success: 200 OK

Fail

Fail: Configuration error

Save Configuration​

Finally, click on “Save configuration”.

Save Configuration

Important: It is required to configure one webhook for each store, so if you have more than one store, repeat the configuration steps for each one of them.