Skip to main content
GET
/
webhooks
/
{id}
Get a webhook
curl --request GET \
  --url https://api.fyatu.com/api/v3.20/webhooks/{id} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "status": 200,
  "message": "Webhook 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"
  },
  "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 the full details for a single webhook endpoint, including delivery health statistics.

​
Path Parameters

ParameterTypeDescription
idstringThe webhook ID (prefix whk_)

​
Example

curl https://api.fyatu.com/api/v3.20/webhooks/whk_01HXYZ7777ABCDEF4444 \
  -H "Authorization: Bearer $FYATU_API_KEY"

​
Success Response (200)

{
  "success": true,
  "status":  200,
  "message": "Webhook retrieved",
  "data": {
    "webhookId":          "whk_01HXYZ7777ABCDEF4444",
    "url":                "https://yourapp.com/webhooks/fyatu",
    "description":        "Production card events",
    "events": [
      "CARD_ISSUED",
      "CARD_FUNDED",
      "TRANSACTION_AUTHORIZED",
      "TRANSACTION_DECLINED",
      "CARDHOLDER_KYC_APPROVED",
      "CARDHOLDER_KYC_REJECTED"
    ],
    "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"
  },
  "meta": {
    "requestId":  "req_01HXY123456ABCDEF",
    "platform": "Fyatu CaaS",
    "timestamp":  "2026-05-22T14:35:00Z"
  }
}

​
Error Codes

CodeHTTPCause
WEBHOOK_NOT_FOUND404Webhook does not exist or belongs to another business/environment
INSUFFICIENT_SCOPE403Key lacks webhooks:read scope

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Response

Webhook retrieved

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
Example:

"Webhook retrieved"

​
data
object
​
meta
object