Skip to main content
PUT
Update Webhook Endpoint

Update Webhook Endpoint

PUT https://api.baanx.com/v1/webhooks/{id} Updates an existing webhook configuration.

Overview

All fields are optional — only provide the fields you want to change. The response returns the full updated webhook configuration with a masked API key.
To change the API key used for signature verification, use the Rotate Key endpoint instead.

Authentication

This endpoint requires authentication via Bearer token:

Request

Headers

string
required
Bearer token for authentication
string
required
Must be application/json

Path Parameters

string (UUID)
required
Unique identifier of the webhook configuration to update

Body

All body fields are optional. Only include the fields you wish to update.
string
New human-readable name for the webhook (max 255 characters)
string
New HTTPS endpoint URL. Must use HTTPS.
array
New list of event type strings. Replaces the existing list. Must contain at least one item if provided.
boolean
Set to true to activate or false to deactivate the webhook
object
Custom metadata to attach to the webhook. Replaces existing metadata.

Request Examples

Response

200 Success

boolean
Indicates the webhook was updated successfully
object
The full updated webhook configuration with masked API key. See Get Webhook for field descriptions.

Error Responses

  • GET /v1/webhooks/{id} - Get current webhook configuration
  • POST /v1/webhooks/{id}/rotate-key - Rotate the signing API key
  • DELETE /v1/webhooks/{id} - Delete this webhook