Send a sample webhook

POST

/v1/webhooks/b2b/sample

Dispatches a realistic sample webhook payload signed with your webhook secret directly to your configured webhook URL. Your webhook URL for this key’s mode (live or test) must be set first in the developer portal under API Keys.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Success

Bodyapplication/json

🟠400

🟠401

🟠403

🟠429

Request Example

Shell

JavaScript

Java

Swift

curl --location 'http://localhost:5050/v1/webhooks/b2b/sample' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://example.com/webhook",
    "event": "datapin.processing"
}'

Response Example

200 - Success

{
    "success": true,
    "message": "Sample webhook dispatched",
    "statusCode": 200,
    "path": "/v1/…",
    "timestamp": "2026-09-26T12:00:00.000Z",
    "hash": "a1b2c3d4-…",
    "data": {
        "sent": true,
        "delivered": true,
        "event": "data.delivered",
        "url": "https://example.com/webhook",
        "deliveryId": "d3b07384-d113-4f44-90aa-9a7c366ff123",
        "statusCode": 200,
        "durationMs": 125,
        "signatureHeader": "t=1728320000,v1=a1b2c3d4...",
        "payload": {
            "id": "d3b07384-d113-4f44-90aa-9a7c366ff123",
            "event": "data.delivered",
            "environment": "live",
            "createdAt": "2026-10-07T18:00:00.000Z",
            "data": {
                "type": "DATA",
                "reference": "DB-DATA-SAMPLE-7A3C9D21",
                "status": "SUCCESS",
                "network": "MTN",
                "recipient": "08012345678",
                "planId": "MTN-1GB-30D",
                "amount": 480,
                "currency": "NGN",
                "isSample": true
            }
        },
        "error": null,
        "message": "Sample webhook data.delivered delivered successfully to https://example.com/webhook (HTTP 200)."
    }
}

Modified at 2026-10-07 17:31:10

List supported webhook events

PurchaseDataDto