Skip to main content
PUT
/
v2
/
webhooks
/
{webhook_id}
Update Webhook
curl --request PUT \
  --url https://api.example.com/v2/webhooks/{webhook_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "url": "<string>",
  "events": [
    {}
  ],
  "is_active": true
}
'
{
  "success": true,
  "data": {
    "webhook_id": "6789abcdef0123456789abcd",
    "updated": true
  },
  "metadata": {
    "action": "update_webhook",
    "credits_consumed": 0,
    "timestamp": "2025-01-15T10:30:00.000000"
  }
}
Update the URL, events, or active status of an existing webhook.

​
Header Parameters

​
x-api-key
string
required
Your API key

​
Path Parameters

​
webhook_id
string
required
The unique identifier of the webhook to update

​
Body Parameters

​
url
string
New webhook URL. Must be a publicly accessible HTTPS endpoint.
​
events
array
New list of event types to listen for (e.g. ["message_received", "accepted_invitation"]).
​
is_active
boolean
Set to false to pause the webhook without deleting it.

​
Response

​
success
boolean
Whether the update was successful
​
data
object
{
  "success": true,
  "data": {
    "webhook_id": "6789abcdef0123456789abcd",
    "updated": true
  },
  "metadata": {
    "action": "update_webhook",
    "credits_consumed": 0,
    "timestamp": "2025-01-15T10:30:00.000000"
  }
}

​
Notes

  • Only the fields you include in the request body will be updated
  • Setting is_active to false does not stop monitoring — use POST /v2/webhooks/{webhook_id}/stop for that