Skip to main content
PUT
Update Webhook URL

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

string
required
The HTTPS URL where webhooks will be sent. Set to null or empty string to disable webhooks.

Response

boolean
Whether the request was successful
object

Validation Rules

Disabling Webhooks

To disable webhooks, send an empty string or 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