Skip to main content
POST
/
blnkwebhook
curl -X POST http://localhost:8081/blnkwebhook \
  -H "Content-Type: application/json" \
  -d '{
    "event": "transaction.created",
    "data": {
      "transaction_id": "txn_123",
      "amount": 1000.00,
      "currency": "USD",
      "source": "balance_123",
      "destination": "balance_456",
      "reference": "ref_001",
      "status": "applied",
      "created_at": "2026-03-16T09:00:00Z",
      "meta_data": {
        "source_country": "US"
      }
    }
  }'
Transaction txn_123 from webhook event 'transaction.created' processed successfully

Documentation Index

Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt

Use this file to discover all available pages before exploring further.

Blnk Watch is currently in beta. Send us a message
Use this endpoint when Blnk Core sends transaction events to Watch through a hook. Watch unwraps the webhook payload, injects the transaction, and evaluates it against your active instructions. This follows the same evaluation flow as inject transaction. After processing, use get verdict to read the result, or configure ALERT_WEBHOOK_URL to receive alerts when rules match.
See Getting data into Watch for how to register a Core hook that points at this endpoint.

Body

event
string
required
The Blnk webhook event name. For example, transaction.created.
data
object
required
The transaction object from Blnk Core. Field names match Blnk transaction naming — transaction_id, amount, currency, source, destination, created_at, meta_data, and so on.
curl -X POST http://localhost:8081/blnkwebhook \
  -H "Content-Type: application/json" \
  -d '{
    "event": "transaction.created",
    "data": {
      "transaction_id": "txn_123",
      "amount": 1000.00,
      "currency": "USD",
      "source": "balance_123",
      "destination": "balance_456",
      "reference": "ref_001",
      "status": "applied",
      "created_at": "2026-03-16T09:00:00Z",
      "meta_data": {
        "source_country": "US"
      }
    }
  }'
Transaction txn_123 from webhook event 'transaction.created' processed successfully

Notes

  • If data.transaction_id is missing, Watch generates a UUID before evaluation.
  • If data.created_at is missing, Watch uses the current server time.
  • On success, the response body is plain text, not JSON.

Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.