​
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

{
  "name": "Pre-transaction validation",
  "url": "https://api.example.com/validate",
  "type": "PRE_TRANSACTION",
  "active": true,
  "timeout": 30,
  "retry_count": 3
}
FieldTypeDescription
namestringName of the hook
urlstringEndpoint URL where the hook will send requests
typestringType of the hook — PRE_TRANSACTION or POST_TRANSACTION
activebooleanIndicates whether the hook is enabled or disabled
timeoutnumberMaximum time (in seconds) allowed for the hook to execute
retry_countnumberMaximum 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

DELEhttp://TE 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.

Sign up on Blnk Cloud

Connect your Blnk Ledger and explore advanced features (access control & collaboration, anomaly detection, secure storage & file management, etc.) in one intuitive dashboard.

Was this page helpful?

Suggest edits
Previous
Examples
Next