Transaction hooks

Register new hooks

POST/hooks

Body

namestringrequiredbody

Name of the hook. Ensure it is as descriptive as possible for easy reference.

urlstringrequiredbody

Endpoint URL where the hook will send requests.

typestringrequiredbody

Type of the hook - PRE_TRANSACTION or POST_TRANSACTION.

activebooleanrequiredbody

Indicates whether the hook is enabled or disabled.

timeoutnumberrequiredbody

Maximum time (in seconds) allowed for the hook to execute.

retry_countnumberrequiredbody

Maximum number of retry attempts if the hook fails.

curl -X POST "http://localhost:5001/hooks" \
  -H "X-blnk-key: <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Pre-transaction validation",
    "url": "https://api.example.com/validate",
    "type": "PRE_TRANSACTION",
    "active": true,
    "timeout": 30,
    "retry_count": 3
  }'

{
  "error": "hook management requires master key",
  "error_detail": {
    "code": "AUTH_MASTER_KEY_REQUIRED",
    "message": "hook management requires master key"
  }
}