Agent Webhooks
Update Webhook
Update an existing webhook configuration
PUT
Overview
Updates an existing webhook configuration. All fields are optional - only provided fields will be updated.Endpoint
string
required
Agent UUID
string
required
Webhook UUID
Request
Response
boolean
Indicates if the webhook was updated successfully
string
Success message
object
Updated webhook object
string
Unique webhook identifier
string
Agent UUID this webhook belongs to
string
Updated webhook name
string
Updated webhook URL
array
Updated array of configured event types
integer
Updated request timeout in seconds
integer
Updated maximum retry attempts
boolean
Updated webhook status
string
ISO 8601 timestamp when webhook was created
string
ISO 8601 timestamp when webhook was last updated
integer
Number of events configured for this webhook
string
Current webhook status
Error responses
Validation rules
- name: Optional, string, maximum 255 characters
- webhook_url: Optional, valid URL, maximum 500 characters
- webhook_secret: Optional, string, maximum 255 characters
- events: Optional, array with minimum 1 event, each event must be from available events list
- timeout: Optional, integer between 5-120 seconds
- max_retries: Optional, integer between 0-10
- enabled: Optional, boolean
Important notes
- All fields are optional - only provided fields will be updated
- Webhook operations automatically clear the agent cache for immediate effect
- Use HTTPS endpoints for webhook URLs in production
- Implement proper signature verification using the webhook secret for security
Related endpoints
- List Agent Webhooks - Get all webhooks for an agent
- Create Webhook - Set up a new webhook
- Get Webhook Details - Retrieve specific webhook information
- Delete Webhook - Remove webhook configuration
- Toggle Webhook Status - Enable/disable webhook
- Test Webhook - Send test payload to verify connectivity