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.
Available in version 0.8.4 and later.
Overview
Efficiently manage hooks through our dedicated hook endpoints. These endpoints seamlessly integrate with the hook manager, providing robust validation, comprehensive error handling, and consistent response delivery.
Register a new hook
POST http://YOUR_BLNK_INSTANCE_URL/hooks
Create pre-transaction hook
Create post-transaction hook
Payload (Pre-transaction)
Payload (Post-transaction)
curl -X POST "http://YOUR_BLNK_INSTANCE_URL/hooks" \
-H "X-Blnk-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Pre-transaction validation",
"url": "https://api.example.com/webhook",
"type": "PRE_TRANSACTION",
"active": true,
"timeout": 30,
"retry_count": 3
}'
Field Type Description namestring Name of the hook urlstring Endpoint URL where the hook will send requests typestring Type of the hook — PRE_TRANSACTION or POST_TRANSACTION activeboolean Indicates whether the hook is enabled or disabled timeoutnumber Maximum time (in seconds) allowed for the hook to execute retry_countnumber Maximum number of retry attempts if the hook fails
Update an existing hook
PUT http://YOUR_BLNK_INSTANCE_URL/hooks/{hook_id}
Retrieve a specific hook
GET http://YOUR_BLNK_INSTANCE_URL/hooks/{hook_id}
List hooks by type
GET http://YOUR_BLNK_INSTANCE_URL/hooks?type=PRE_TRANSACTION
Delete a hook
DELETE http://YOUR_BLNK_INSTANCE_URL/hooks/{hook_id}
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 .
Tip: Connect to Blnk Cloud to see your Core data.You can view your transactions, manage identities, create custom reports, invite other team members to collaborate, and perform operations on your Core — all in one dashboard. Check out Blnk Cloud →