Update webhook endpoint

PATCH https://app.speybooks.com/api/v1/webhook-endpoints/{id}

Update an existing webhook endpoint. Any combination of url, description, events, and isActive can be updated. The signing secret is not changed — use the rotate endpoint for that.

Set isActive: false to temporarily pause deliveries without deleting the endpoint configuration.

Path parameters

id integer required

Webhook endpoint ID.

Body parameters

description string optional

Updated description.

events array<string> optional

Updated event subscriptions.

isActive boolean optional

Enable or disable the endpoint.

url string optional

Updated HTTPS delivery URL.

Response

200 Webhook endpoint updated. Returns the full endpoint object.

Show response fields

events array<string>

id integer

isActive boolean

url string

Error codes

400 Validation error: invalid URL or event types.

404 Webhook endpoint not found.

Request PATCH /v1/webhook-endpoints/{id} curl

curl -X PATCH https://api.speybooks.com/v1/webhooks/3 \
  -H "Authorization: Bearer sk_test_..." \
  -H "Content-Type: application/json" \
  -d '{"events": ["invoice.paid", "invoice.overdue"], "isActive": true}'

Response 200

{
  "success": true,
  "data": {
    "id": 3,
    "url": "https://example.com/webhooks/speybooks",
    "events": [
      "invoice.paid",
      "invoice.overdue"
    ],
    "isActive": true
  }
}