Update webhook endpoint

Change an endpoint’s URL, event types or description, or turn it off and on.

PATCH /api/v1/webhook_endpoints/{webhook_endpoint_id}

cURL

curl -X PATCH "https://api.wordsmith.ai/api/v1/webhook_endpoints/0e7b3c5a-9d21-4f86-b4a0-6c8e2f1d7a39" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true}'

Response

{
  "id": "0e7b3c5a-9d21-4f86-b4a0-6c8e2f1d7a39",
  "url": "https://your-app.com/webhooks/wordsmith",
  "description": "Matter management sync",
  "event_types": [
    "task.assigned",
    "task.status_changed",
    "review.completed"
  ],
  "audience": "user",
  "status": "enabled",
  "disabled_reason": null,
  "api_version": "2026-11-01",
  "last_delivery": {
    "at": "2026-11-09T10:12:04Z",
    "delivered": true,
    "response_status": 200,
    "error_code": null
  },
  "created_at": "2026-11-09T10:00:00Z",
  "updated_at": "2026-11-09T10:00:00Z"
}

Changes only the fields you send. Send "enabled": true to turn an endpoint back on after it was turned off or marked failing.

​

Authentication

Requires an API key, or an OAuth token with webhooks:write. An organisation endpoint also needs webhooks:admin, the organisation-webhooks permission and a plan that includes organisation endpoints.

​

Path parameters

webhook_endpoint_id · string · required

The endpoint.

​

Body parameters

url · string

A new public https URL.

event_types · string[]

Replaces the endpoint’s event types.

description · string

Replaces the description. null clears it.

enabled · boolean

false stops sending. true starts again.

​

Response

Returns the updated endpoint.

cURL

curl -X PATCH "https://api.wordsmith.ai/api/v1/webhook_endpoints/0e7b3c5a-9d21-4f86-b4a0-6c8e2f1d7a39" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true}'

Response

{
  "id": "0e7b3c5a-9d21-4f86-b4a0-6c8e2f1d7a39",
  "url": "https://your-app.com/webhooks/wordsmith",
  "description": "Matter management sync",
  "event_types": [
    "task.assigned",
    "task.status_changed",
    "review.completed"
  ],
  "audience": "user",
  "status": "enabled",
  "disabled_reason": null,
  "api_version": "2026-11-01",
  "last_delivery": {
    "at": "2026-11-09T10:12:04Z",
    "delivered": true,
    "response_status": 200,
    "error_code": null
  },
  "created_at": "2026-11-09T10:00:00Z",
  "updated_at": "2026-11-09T10:00:00Z"
}

​

Errors

Status	error_code	When
400	invalid_webhook_url	The URL is not a public https URL.
400	invalid_event_type	An event type that does not exist.
404	resource_not_found	No endpoint with this id that you can manage, or webhooks are not on for your organisation.