Webhooks API

What are Webhooks?

Webhooks allow your application to receive real-time HTTP POST notifications when certain events occur in your PayDirect account, such as payment status changes, wallet updates, or agent actions.

Registering Webhook Endpoints

You can register and manage webhook endpoints in your Developer Dashboard.

1. Go to the Webhooks section in the dashboard
2. Click "Add Endpoint"
3. Enter your endpoint URL and select the events you want to subscribe to
4. Save your changes

Event Types

You can subscribe to the following event types:

Example Webhook Payload

Webhook requests are sent as JSON in the POST body. Here’s an example for a payment update:

{
  "event": "payment.updated",
  "data": {
    "paymentId": "pay_abc123",
    "status": "completed",
    "amount": "0.5",
    "currency": "ETH",
    "updatedAt": "2024-03-20T12:00:00Z"
  }
}

Security & Verification

Each webhook request includes a X-PayDirect-Signature header. Use this to verify the authenticity of the request:

// Example: Verifying the signature in Node.js
const crypto = require('crypto');
const signature = req.headers['x-paydirect-signature'];
const payload = JSON.stringify(req.body);
const secret = process.env.PAYDIRECT_WEBHOOK_SECRET;

const expected = crypto
  .createHmac('sha256', secret)
  .update(payload)
  .digest('hex');

if (signature !== expected) {
  // Reject the request
}