Skip to main content
PUT
/
webhooks
Update Webhook URL
curl --request PUT \
  --url https://api.fyatu.com/api/v3/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhookUrl": "https://example.com/webhooks/fyatu"
}
'
{
  "success": true,
  "status": 200,
  "message": "Webhook URL updated successfully",
  "data": {
    "webhookUrl": "https://example.com/webhooks/fyatu",
    "hasWebhookSecret": true,
    "isConfigured": true,
    "webhookSecret": "whsec_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "secretNote": "This is your webhook secret. Store it securely - it will not be shown again."
  },
  "meta": {
    "requestId": "req_abc123xyz789",
    "timestamp": "2026-01-15T10:30:00+00:00"
  }
}

​
Update Webhook URL

Set or update the webhook URL where FYATU will send event notifications. The URL must use HTTPS. If this is the first time setting a webhook URL, a webhook secret will be automatically generated and returned in the response. Store this secret securely - it will not be shown again.

​
Request

​
webhookUrl
string
required
The HTTPS URL where webhooks will be sent. Set to null or empty string to disable webhooks.
curl -X PUT https://api.fyatu.com/api/v3/webhooks \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "webhookUrl": "https://example.com/webhooks/fyatu"
  }'

​
Response

​
success
boolean
Whether the request was successful
​
data
object
{
  "success": true,
  "status": 200,
  "message": "Webhook URL updated successfully",
  "data": {
    "webhookUrl": "https://example.com/webhooks/fyatu",
    "hasWebhookSecret": true,
    "isConfigured": true,
    "webhookSecret": "whsec_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "secretNote": "This is your webhook secret. Store it securely - it will not be shown again."
  },
  "meta": {
    "requestId": "req_abc123xyz789",
    "timestamp": "2026-01-15T10:30:00+00:00"
  }
}

​
Validation Rules

RuleDescription
HTTPS RequiredWebhook URL must use https:// protocol
Valid URLMust be a properly formatted URL
Max LengthURL must be less than 500 characters

​
Disabling Webhooks

To disable webhooks, send an empty string or null: 
curl -X PUT https://api.fyatu.com/api/v3/webhooks \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "webhookUrl": null
  }'
When you first configure a webhook URL, a secret will be generated. Copy and store it immediately as it will not be displayed again. You’ll need this secret to verify webhook signatures.

Authorizations

​
Authorization
string
header
required

JWT access token obtained from /auth/token

Body

application/json
​
webhookUrl
string<uri>
required

The HTTPS URL where webhook events will be sent. Must use HTTPS protocol.

Example:

"https://example.com/webhooks/fyatu"

Response

Webhook URL updated successfully

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
​
data
object
​
meta
object