Register New Hooks

POST

hooks

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"
  }
}

Available in version 0.8.4 or later.

Send the master key (server.secret_key) in the X-Blnk-Key header. Regular API keys return 403 Forbidden.

Body

string

required

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

string

required

Endpoint URL where the hook will send requests.

string

required

Type of the hook - PRE_TRANSACTION or POST_TRANSACTION.

boolean

required

Indicates whether the hook is enabled or disabled.

number

required

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

number

required

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"
  }
}

Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.

Check reindex progress

Update an existing hook

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"
  }
}

Start Here

Ledgers

Ledger balances

Transactions

Reconciliation

Identities

Metadata

Search

Transaction hooks

API keys

System

Body

Need help?

​Body

​Need help?

Body

Need help?