Skip to main content
GET
/
hooks
/
{id}
View hook details
curl --request GET \
  --url http://localhost:5001/hooks/{id} \
  --header 'X-blnk-key: <api-key>'
Use blnk.Hooks.get to fetch a single webhook by its ID.
blnk.Hooks.get
const response = await blnk.Hooks.get('hk_test_123');
FieldDescription
idID of the hook to retrieve.

​
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
idUnique ID for the hook.
typePRE_TRANSACTION or POST_TRANSACTION.
activeWhether the hook is enabled.
last_runDate and time the hook last executed.
last_successWhether the most recent execution succeeded.

How webhooks work

Hook types, payloads, and execution.

View hook details

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.