📣 Webhooks

📢 Overview

The Capa API provides a webhook-based notification system that allows third-party partners to receive real-time updates whenever specific events occur in our backend systems. This enables partners to stay informed about changes related to their users or transactions and to make necessary updates in their systems accordingly.

🔧 How It Works

1. 🔗 Registering a Webhook URL:
   Each partner can register a single URL where they wish to receive webhook notifications. This URL must be provided through the designated endpoint. Set Webhook Settings

2. 📬 Receiving Notifications:
   Once a URL is registered, partners will receive notifications whenever an event relevant to them occurs, such as:

   • 📝 Updates to a user's KYC (Know Your Customer) status.
   • 💸 Transaction status changes

3. 📡 Notification Handling:
   If a notification fails to be delivered (e.g., due to network issues or a problem on the partner's end), the system will automatically retry the delivery up to 5 times with increasing delays. If all attempts fail, the notification will be marked as "Failed."

4. 🔄 Retrying Failed Notifications:
   Partners have the ability to manually retry the delivery of failed notifications by making a POST request to a specific endpoint designed for this purpose.

💡 Best Practices

• 🕒 Ensure Availability: Make sure your webhook URL is always available to receive notifications.
• 🤖 Handle Retries Gracefully: Implement logic to handle repeated notifications in case of retries.
• 🔍 Validate Data: Validate all incoming data to ensure it is from a trusted source and in the expected format.