Update Webhook

Update an existing webhook’s URL, events, description, or active status.

PUT /api/webhooks

Update Webhook

cURL

curl --request PUT \
  --url https://encrata.com/api/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "description": "<string>",
  "is_active": true
}
'

Authentication

Requires an API key in the Authorization header.

Authorization: Bearer YOUR_API_KEY

Request

id · string · required

The webhook ID to update.

url · string · required

The updated HTTPS URL.

events · string[]

Updated list of subscribed event types.

description · string

Updated description.

is_active · boolean

Set to false to pause deliveries without deleting the webhook.

Example request

curl -X PUT https://encrata.com/api/webhooks \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
    "id": "360cb300-d885-4c18-af2c-d259f936bb38",
    "url": "https://example.com/webhook-v2",
    "events": ["lookup.completed"],
    "description": "Updated webhook",
    "is_active": true
  }'

Response

Example response

{
  "status": "updated"
}