Skip to main content
GET
/
webhooks
List webhooks
curl --request GET \
  --url https://api.fyatu.com/api/v3.20/webhooks \
  --header 'Authorization: Bearer <token>'
{
  "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"
      ],
      "environment": "LIVE",
      "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.fyatu.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
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",
      "environment":        "LIVE",
      "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