Overview

Webhooks enable i-payout to provide real-time information whenever an event happens without needing constant requests. They are a passive method to receive data between two systems through an HTTP POST. After configuring the webhooks in your system, you will receive event notifications every time an activity or function is triggered within the specified flow.

Why Do We Recommend Using Webhooks?

Webhooks are the best way to ensure your system is up-to-date with payment progress and status. Since the event notifications trigger automatically, your system won't need to perform recurrent requests. This ensures that you process the payment information on demand, improving efficiency and reducing the server load.

What Do You Need to Know Before Starting to Use Webhooks?

To start using webhooks, you need to build a public REST API to receive event notifications (POST requests). The REST API you build should not require authentication or access restriction through a header. Despite using a public API, the communication system is very safe since event notifications will not be available to the public and will use a unique URL to communicate only with your REST API.

Webhook Notifications

i-payout integrates Webhook functionality to provide merchants with real-time notifications about significant events within the system, particularly for PayIns. These asynchronous notifications are crucial for tracking customer actions outside direct merchant interactions, such as delayed payments initiated through sent links. This system ensures merchants receive immediate updates, enabling them to respond swiftly to customer actions. Notifications are delivered as JSON objects, offering detailed event information in a structured format.

Key Features

• Real-Time Updates: Merchants are informed of events as they happen, enhancing responsiveness to beneficiaries' actions.
• JSON Notification Format: Notifications are structured as JSON objects, ensuring compatibility and ease of integration with merchant systems.
• Asynchronous Communication: Allows monitoring of customer-initiated events without requiring constant polling of the i-payout API.

What's next?

Now that you know the basics about Webhooks, read our Webhook Security guide to understand how i-payout ensures your Webhooks are secure.