Webhooks allow you to receive real-time updates directly to your server when specific events occur in our system. This feature ensures that your application is always in sync with the latest changes without the need to constantly poll our API.

What Are Webhooks?

Webhooks are HTTP callbacks that notify your application whenever an event occurs. For instance, when a payment is processed, a payout is made, or a cancellation happens, our system automatically sends the corresponding object data to the URL you have specified. This means you receive the actual object data, allowing you to react instantly to changes.

Setting Up Your Webhook Endpoints

You can easily configure your webhook endpoints via our Platform Dashboard:

1. Log In: Access the Platform Dashboard at portal.paybucky.com using your provided Email and Password.

2. Navigate to the Developer Section: Once logged in, locate the Developer-item in the dashboard menu. From there switch the tab to the Settings-tab

3. Add or Edit Endpoints: Here, you can add new webhook endpoints or update existing ones. Simply input the URL where you’d like to receive webhook notifications. See image below.

4. Receive Updates: From now on, whenever a change occurs—for example, a payment object is updated or a cancellation is made—our system will send the corresponding object data to the URL you specified.

How Webhooks Work

• Real-Time Notifications: When an event is triggered (e.g., a new payment is received), our system sends an HTTP POST request to your designated endpoint.

• Payload Details: The POST request contains a payload with detailed information about the event, including the full object data.

  {
    "eventID": "d46f1727-e9a7-48f0-b2f9-53fe4cc9a2a5",
    "createTime": "2024-03-09 11:53:12.743",
    // See the individual webhook-sections for more concrete examples
    "type": "payment", // The type of webhook, e.g "payment", "connectedaccount" etc.
    "payload": {...}
  }

  json

• Automatic Updates: This process eliminates the need for manual checks, allowing your system to automatically process the incoming data and trigger any necessary workflows.

Benefits of Using Webhooks

• Efficiency: Automatically stay updated with real-time data without repeatedly querying the API.

• Automation: Streamline processes such as order fulfillment, fraud detection, or customer notifications.

• Reliability: Ensure your application is promptly informed of every transaction or event change, helping maintain data integrity across systems.

By configuring your webhook endpoints in our Platform Dashboard, you ensure that your application will always receive the necessary data directly as events occur. This seamless integration supports a more dynamic and responsive system for managing your payments and related services.