Skip to main content
GET
/
webhooks
List webhooks
curl --request GET \
  --url https://api.fyatu.com/api/v3.20/webhooks \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.fyatu.com/api/v3.20/webhooks"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fyatu.com/api/v3.20/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.fyatu.com/api/v3.20/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$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 := "https://api.fyatu.com/api/v3.20/webhooks"

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

req.Header.Add("Authorization", "Bearer <token>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.fyatu.com/api/v3.20/webhooks")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.fyatu.com/api/v3.20/webhooks")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "success": true,
  "status": 200,
  "message": "Webhooks retrieved",
  "data": [
    {
      "webhookId": "whk_01HXYZ7777ABCDEF4444",
      "url": "https://yourapp.com/webhooks/fyatu",
      "description": "Production card events",
      "events": [
        "CARD_ISSUED",
        "TRANSACTION_AUTHORIZED"
      ],
      "status": "ACTIVE",
      "secretPrefix": "whsec_a1b2c3",
      "failureCount": 0,
      "lastDeliveryAt": "2026-05-22T14:30:00Z",
      "lastDeliveryStatus": "SUCCESS",
      "totalDeliveries": 45,
      "totalFailures": 0,
      "createdAt": "2026-05-01T09:00:00Z",
      "updatedAt": "2026-05-10T14:23:00Z"
    }
  ],
  "pagination": {
    "total": 47,
    "limit": 20,
    "offset": 0,
    "hasMore": true
  },
  "meta": {
    "requestId": "req_a1b2c3d4e5f6a7b8c9d0e1f2",
    "platform": "Fyatu CaaS",
    "timestamp": "2026-05-22T15:00:00Z"
  }
}

Overview

Returns all non-deleted webhook endpoints for your business in the current environment, along with delivery health statistics for each.

Query Parameters

ParameterTypeDefaultDescription
limitinteger20Results per page (max 100)
offsetinteger0Number of records to skip

Example

curl https://api.fyatu.com/api/v3.20/webhooks \
  -H "Authorization: Bearer $FYATU_API_KEY"
const resp = await fetch('https://api.fyatu.com/api/v3.20/webhooks', {
  headers: { 'Authorization': `Bearer ${process.env.FYATU_API_KEY}` }
});
const body = await resp.json();
for (const wh of body.data) {
  console.log(wh.webhookId, wh.status, `${wh.failureCount} failures`);
}
import os, requests

resp = requests.get(
    'https://api.fyatu.com/api/v3.20/webhooks',
    headers={'Authorization': f'Bearer {os.environ["FYATU_API_KEY"]}'}
)
body = resp.json()
for wh in body['data']:
    print(wh['webhookId'], wh['status'], f"{wh['failureCount']} failures")

Success Response (200)

{
  "success": true,
  "status":  200,
  "message": "Webhooks retrieved",
  "data": [
    {
      "webhookId":          "whk_01HXYZ7777ABCDEF4444",
      "url":                "https://yourapp.com/webhooks/fyatu",
      "description":        "Production card events",
      "events":             ["CARD_ISSUED", "TRANSACTION_AUTHORIZED"],
      "status":             "ACTIVE",
      "secretPrefix":       "whsec_a1b2c3",
      "failureCount":       0,
      "lastDeliveryAt":     "2026-05-22T14:30:00Z",
      "lastDeliveryStatus": "SUCCESS",
      "totalDeliveries":    142,
      "totalFailures":      1,
      "createdAt":          "2026-05-01T09:00:00Z",
      "updatedAt":          "2026-05-22T14:30:00Z"
    }
  ],
  "pagination": {
    "total":   2,
    "limit":   20,
    "offset":  0,
    "hasMore": false
  },
  "meta": {
    "requestId":  "req_01HXY123456ABCDEF",
    "platform": "Fyatu CaaS",
    "timestamp":  "2026-05-22T15:00:00Z"
  }
}

Error Codes

CodeHTTPCause
INSUFFICIENT_SCOPE403Key lacks webhooks:read scope

Authorizations

Authorization
string
header
required

API key from the FYATU CaaS portal. Pass as Authorization: Bearer <key>.

Query Parameters

limit
integer
default:20
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0

Response

Webhooks retrieved

success
boolean
Example:

true

status
integer
Example:

200

message
string
Example:

"Webhooks retrieved"

data
object[]
pagination
object
meta
object