Hooks

View hook details

View the details of a hook with the TypeScript SDK.

GET/hooks/{hook_id}

Use blnk.Hooks.get to fetch a single webhook by its ID.

Call the method

const response = await blnk.Hooks.get(
  'hk_890bdbc4-467f-4670-8424-5667e41daf29',
);

Field	Type	Description
`id`	`string`	ID of the hook to retrieve.

Use the hook details

Read response.data for URL, type, active status, and last execution results. Use this to debug hook failures or confirm configuration.

Response

{
  "id": "hk_890bdbc4-467f-4670-8424-5667e41daf29",
  "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
}

Field	Type	Description
`id`	`string`	Unique ID for the hook.
`type`	`string`	`PRE_TRANSACTION` or `POST_TRANSACTION`.
`active`	`boolean`	Whether the hook is enabled.
`last_run`	`string`	Date and time the hook last executed.
`last_success`	`boolean`	Whether the most recent execution succeeded.