Skip to main content
GET
/
hooks
View list of hooks by type
curl --request GET \
  --url http://localhost:5001/hooks \
  --header 'X-blnk-key: <api-key>'
Use blnk.Hooks.list to fetch registered webhooks, optionally filtered by type.
blnk.Hooks.list
const response = await blnk.Hooks.list({ type: 'PRE_TRANSACTION' });
FieldDescription
options.typeOptional filter — PRE_TRANSACTION or POST_TRANSACTION. Omit to list all hooks.

​
Response shape

200 OK
[
  {
    "id": "hk_test_123",
    "name": "Pre-transaction validation",
    "url": "https://api.example.com/validate",
    "type": "PRE_TRANSACTION",
    "active": true,
    "timeout": 30,
    "retry_count": 3,
    "created_at": "2024-11-26T08:36:36.238244338Z",
    "last_run": "2024-11-26T09:12:00.000000000Z",
    "last_success": true
  }
]
FieldDescription
response.dataArray of hook objects returned by Core.
response.data[].idUnique hook ID.
response.data[].typeHook timing, such as PRE_TRANSACTION or POST_TRANSACTION.
response.data[].activeWhether the hook is enabled.

How webhooks work

Hook types, payloads, and execution.

View list of hooks by type

HTTP request and response schema.

​
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.