Hooks

Update an existing hook

Update an existing hook with the Go SDK.

PUT/hooks/{hook_id}

Use client.Hooks.Update to change the configuration of an existing webhook.

Call the method

updated, _, _ := client.Hooks.Update(
	"hk_890bdbc4-467f-4670-8424-5667e41daf29",
	blnkgo.UpdateHookRequest{
		Name:       "Pre-transaction validation",
		URL:        "https://api.example.com/validate",
		Type:       blnkgo.HookTypePreTransaction,
		Active:     false,
		Timeout:    30,
		RetryCount: 3,
	},
)

Field	Type	Description
`hookID`	`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`	`blnkgo.HookType`	`blnkgo.HookTypePreTransaction` or `blnkgo.HookTypePostTransaction`.
`Active`	`bool`	Whether the hook is enabled.
`Timeout`	`int`	Maximum time in seconds allowed for the hook to execute.
`RetryCount`	`int`	Maximum number of retry attempts if the hook fails.

Verify the changes

Read updated to confirm the 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
}

Go response (`*blnkgo.HookResponse`)

Field	Type	Description
`ID`	`string`	Unique ID for the hook.
`Name`	`string`	Updated name for the hook.
`URL`	`string`	Updated endpoint URL.
`Type`	`blnkgo.HookType`	`PRE_TRANSACTION` or `POST_TRANSACTION`.
`Active`	`bool`	Whether the hook is enabled.
`Timeout`	`int`	Maximum time in seconds allowed for the hook to execute.
`RetryCount`	`int`	Maximum number of retry attempts if the hook fails.
`CreatedAt`	`string`	Date and time the hook was created.
`LastRun`	`string`	Date and time the hook last executed.
`LastSuccess`	`bool`	Whether the most recent execution succeeded.

Update an existing hook

Go response (*blnkgo.HookResponse)

Go response (`*blnkgo.HookResponse`)