Skip to main content
GET
/
hooks
View list of hooks by type
curl --request GET \
  --url http://localhost:5001/hooks \
  --header 'X-blnk-key: <api-key>'
import requests

url = "http://localhost:5001/hooks"

headers = {"X-blnk-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-blnk-key': '<api-key>'}};

fetch('http://localhost:5001/hooks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "5001",
  CURLOPT_URL => "http://localhost:5001/hooks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-blnk-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:5001/hooks"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-blnk-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("http://localhost:5001/hooks")
  .header("X-blnk-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:5001/hooks")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["X-blnk-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
Use blnk.hooks.list to fetch registered webhooks, optionally filtered by type.
1

Call the method

blnk.hooks.list
response = blnk.hooks.list({
  "type": "PRE_TRANSACTION",
})
FieldTypeDescription
options.typestrOptional filter: PRE_TRANSACTION or POST_TRANSACTION. Omit to list all hooks.
2

Use the hook list

Iterate over response.data to find hooks by type or active status. Save hook IDs you need for updates or deletion.
3

Response

200 OK
[
  {
    "id": "hk_test_123",
    "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": "2024-11-26T09:12:00.000000000Z",
    "last_success": true
  }
]
FieldTypeDescription
response.datalist[dict]Array of hook objects returned by Core.
response.data[].idstrUnique hook ID.
response.data[].typestrHook timing, such as PRE_TRANSACTION or POST_TRANSACTION.
response.data[].activeboolWhether the hook is enabled.

How webhooks work

Hook types, payloads, and execution.

View list of hooks by type

HTTP request and response schema.

​
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.