Hooks

Update an existing hook

Update an existing hook with the TypeScript SDK.

PUT/hooks/{hook_id}

Use blnk.Hooks.update to change the configuration of an existing webhook.

Call the method

const response = await blnk.Hooks.update(
  'hk_890bdbc4-467f-4670-8424-5667e41daf29',
  {
    name: 'Pre-transaction validation',
    url: 'https://api.example.com/validate',
    type: 'PRE_TRANSACTION',
    active: false,
    timeout: 30,
    retry_count: 3,
  },
);

Field	Type	Description
`id`	`string`	ID of the hook to update.
`name`	`string`	Descriptive name for the hook.
`url`	`string`	Endpoint URL Blnk calls when the hook runs.
`type`	`string`	`PRE_TRANSACTION` or `POST_TRANSACTION`.
`active`	`boolean`	Whether the hook is enabled.
`timeout`	`number`	Maximum time in seconds allowed for the hook to execute.
`retry_count`	`number`	Maximum number of retry attempts if the hook fails.

Verify the changes

Read response.data to confirm the updated URL, type, and active status. The hook ID stays the same.

Response

{
  "id": "hk_890bdbc4-467f-4670-8424-5667e41daf29",
  "name": "Pre-transaction validation",
  "url": "https://api.example.com/validate",
  "type": "PRE_TRANSACTION",
  "active": false,
  "timeout": 30,
  "retry_count": 3,
  "created_at": "2024-11-26T08:36:36.238244338Z",
  "last_run": "0001-01-01T00:00:00Z",
  "last_success": false
}

Field	Type	Description
`id`	`string`	Unique ID for the hook.
`created_at`	`string`	Date and time the hook was created.
`last_run`	`string`	Date and time the hook last executed.
`last_success`	`boolean`	Whether the most recent execution succeeded.