Webhooks 🔌

Overview

Webhooks are HTTP callbacks that deliver notification messages for events. Peach Payments uses webhooks to inform merchant systems when certain events occur. This way, your servers are always up to date with transaction information.

Configure a webhook

The following instructions describe how to add or delete a webhook for Checkout, Ecwid, Magento, Shopify, Wix (for Dashboard only, not sandbox), and WooCommerce.

📘

Only certain roles can add or delete webhooks.

To configure webhooks for other products, see the following documentation:

Add a webhook

Follow these steps to add a webhook:

  1. Log in to your Peach Payments Dashboard.
  2. If you're adding a Checkout webhook, in the left navigation menu, click Checkout. If you're adding a payment extension webhook, in the Connect section, click your payment extension, for example, WooCommerce.
  3. In the Webhooks section, click Add webhook URL.
  4. In the Adding webhook URL window that appears, enter your webhook URL, ensuring that your system responds with a 200 status response. Peach Payments sends two webhooks to this URL, the first without data (curl -v -X POST https://www.mysite.co.za/pp-hosted/secure/webhook) and the second with JSON data (curl -v -H "Content-Type: application/json" -X POST -d '{"test":true}' https://www.mysite.co.za/pp-hosted/secure/webhook) if the initial attempt fails. If both attempts fail to return a 200 status, Peach Payments considers the validation unsuccessful.

The webhook URL appears in the Webhooks section.

Delete a webhook

Follow these steps to delete a webhook:

  1. Log in to your Peach Payments Dashboard.
  2. If you're deleting a Checkout webhook, in the left navigation menu, click Checkout. If you're deleting a payment extension webhook, in the Connect section, click your payment extension, for example, WooCommerce.
  3. In the Webhooks section, click the more options icon next to the webhook that you want to delete, then click Delete.
  4. In the confirmation window, click Delete.

Peach Payments deletes the webhook.

FAQ

Why am I receiving an error when I attempt to configure a webhook

If you've attempted to configure your webhooks as described in the sections above but are receiving errors, add the following IP addresses to your allowlist and try again:

  • Card payments:
    • Production: 185.147.172.128/25, 185.147.174.128/25, and 54.217.71.82
    • Sandbox: 185.147.172.64/26 and 54.155.67.122
  • Checkout and Payment Links:
    • Production: 52.212.210.254
    • Sandbox: 52.31.92.63
  • Payments API:
    • Production: 52.214.127.216, 34.249.103.193, and 52.209.186.130
    • Sandbox: 52.18.99.104, 34.249.176.69, and 34.240.186.230