Get EnterpriseOpen Dashboard

Hooks

Register new hooks

Register a new hook with the Go SDK.

POST/hooks

Use client.Hooks.Create to register a webhook that Blnk calls before or after a transaction.

Call the method

hook, _, _ := client.Hooks.Create(
	blnkgo.CreateHookRequest{
		Name:       "Pre-transaction validation",
		URL:        "https://api.example.com/validate",
		Type:       blnkgo.HookTypePreTransaction,
		Active:     true,
		Timeout:    30,
		RetryCount: 3,
	},
)
FieldTypeDescription
NamestringDescriptive name for the hook.
URLstringEndpoint URL Blnk calls when the hook runs.
Typeblnkgo.HookTypeblnkgo.HookTypePreTransaction or blnkgo.HookTypePostTransaction.
ActiveboolWhether the hook is enabled.
TimeoutintMaximum time in seconds allowed for the hook to execute.
RetryCountintMaximum number of retry attempts if the hook fails.

Save the hook ID

Use hook.ID to view, update, or delete the hook later. Hook management requires the master key.

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": "0001-01-01T00:00:00Z",
  "last_success": false
}

Go response (*blnkgo.HookResponse)

FieldTypeDescription
IDstringUnique ID for the hook. Use it to view, update, or delete the hook.
NamestringName you passed in the request.
URLstringEndpoint URL Blnk calls when the hook runs.
Typeblnkgo.HookTypePRE_TRANSACTION or POST_TRANSACTION.
ActiveboolWhether the hook is enabled.
TimeoutintMaximum time in seconds allowed for the hook to execute.
RetryCountintMaximum number of retry attempts if the hook fails.
CreatedAtstringDate and time the hook was created.
LastRunstringDate and time the hook last executed.
LastSuccessboolWhether the most recent execution succeeded.