API ReferenceWebhooks
Update webhook
Authorization
bearerAuth AuthorizationBearer <token>
API key authentication. Include your API key in the Authorization header as Bearer rf_your_key.
In: header
Path Parameters
id*string
Webhook ID
Request Body
application/json
events?|null
Event types to subscribe to (empty or ["*"] for all events)
headers?|null
Custom headers to include in webhook requests
Items
items <= 10is_active*boolean
Whether this webhook is active
name*string
Unique name for this webhook
Length
1 <= length <= 64secret?string
Secret for HMAC-SHA256 signature (leave empty to disable signing)
Length
length <= 256url*string
Webhook URL to send events to
Format
uriLength
1 <= length[key: string]?never
Response Body
application/json
application/problem+json
curl -X PUT "http://localhost:8080/api/v1/webhooks/string" \ -H "Content-Type: application/json" \ -d '{ "is_active": true, "name": "string", "url": "http://example.com" }'{
"created_at": "string",
"events": [
"string"
],
"has_secret": true,
"headers": [
{
"name": "string",
"value": "string"
}
],
"id": "string",
"is_active": true,
"name": "string",
"updated_at": "string",
"url": "string"
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "string",
"message": "string",
"value": null
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}