Skip to main content
PUT
/
webhooks
Update Webhook
curl --request PUT \
  --url https://api.fyatu.com/api/v3.20/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "webhookUrl": "https://yourdomain.com/fyatu/webhook"
}
'
{}

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

Set or update the webhook URL that receives event notifications for your business. A signing secret (webhookSecret) is generated automatically on first configuration.

​
Request Body

FieldTypeRequiredDescription
webhookUrlstringYesHTTPS endpoint to receive webhook events

​
Requirements

  • URL must be https:// (HTTP not accepted in production)
  • URL must return 2xx for successful delivery — FYATU retries on non-2xx responses
  • URL must respond within 10 seconds

​
Response

On first configuration, the response includes the webhookSecret: 
{
  "success": true,
  "data": {
    "webhookUrl": "https://yoursite.com/webhooks/fyatu",
    "isConfigured": true,
    "hasWebhookSecret": true,
    "webhookSecret": "whsec_a1b2c3d4e5f6g7h8i9j0",
    "secretNote": "Store this securely — it will not be shown again."
  }
}
On subsequent updates, webhookSecret is not returned (secret unchanged).
The webhookSecret is shown only once on initial configuration. Store it securely in your environment variables. If lost, use POST /webhooks/secret/regenerate to issue a new secret.

Authorizations

​
Authorization
string
header
required

JWT access token obtained from POST /auth/token

Body

application/json
​
webhookUrl
string<uri>
required

Response

200 - application/json

Webhook updated

The response is of type object.