Update a webhook configuration

Updates specific fields of an existing webhook configuration.

Business Context:
Use this endpoint to modify webhook settings such as endpoint URLs, event subscriptions,
security configurations, or enable/disable status without requiring webhook recreation.

What Can Be Updated:

Endpoint Configuration:

  • Target URL and HTTP method
  • Description and documentation
  • Enable/disable status

Event Subscriptions:

  • Add or remove event types
  • Modify event filtering
  • Update subscription scope

Security Settings:

  • Webhook secret for signature validation
  • SSL certificate configuration (CA, client certs)
  • Authentication headers and tokens

Operational Settings:

  • Enable or disable webhook delivery
  • Retry configuration and timeouts
  • Rate limiting parameters

Business Rules:

  • URL changes take effect immediately for new events
  • Event subscription changes apply to future events only
  • Disabled webhooks stop receiving all events
  • Security changes require webhook endpoint updates

Common Use Cases:

  • Updating webhook URLs during infrastructure changes
  • Adding or removing event subscriptions
  • Enabling/disabling webhooks for maintenance
  • Updating security secrets during key rotation
  • Modifying descriptions for better documentation

Impact Assessment:

  • URL Changes: Test new endpoint before updating
  • Event Changes: Review downstream systems for compatibility
  • Security Updates: Coordinate with webhook endpoint maintainers
  • Status Changes: Monitor integration health after changes

Best Practices:

  • Gradual Updates: Test changes in development first
  • Monitoring: Watch delivery metrics after configuration changes
  • Documentation: Update integration documentation after changes
  • Backup: Record previous configuration before major updates
  • Coordination: Notify webhook endpoint owners of changes
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The unique reference identifier of the webhook.

Body Params
uri
length ≤ 255

The URL the webhook request will be sent to. Must be HTTPS.

string
enum

The HTTP method that will be used for webhook delivery.

Allowed:
events
array of objects
length ≥ 1

The events that will trigger the webhook to send.

events
string | null

A human-readable description of the webhook's purpose.

boolean

Whether or not the webhook is enabled.

string | null

The webhook secret used for HMAC signature validation.

string | null

The path to the CA certificate for SSL verification.

string | null

The path to the private key for client certificate authentication.

string | null

The path to the client certificate for SSL authentication.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/ld+json