Update webhook endpoint

PATCHhttps://app.speybooks.com/api/v1/webhooks/{id}

Update an existing webhook endpoint. Any combination of url, description, events, and isActive can be updated. The signing secret is not changed and is not included in the response; the response carries secretHint. Use the rotate endpoint to change the secret.

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

Path parameters

idintegerrequired

Webhook endpoint ID.

Body parameters

descriptionstringoptional

Updated description.

eventsarray<string>optional

Updated event subscriptions.

isActivebooleanoptional

Enable or disable the endpoint.

urlstringoptional

Updated HTTPS delivery URL. Plain HTTP is rejected.

Response

200Webhook endpoint updated. Returns the full endpoint object.

Show response fields

eventsarray<string>

idinteger

isActiveboolean

urlstring

Error codes

400Validation error: invalid URL or event types.

404Webhook endpoint not found.

RequestPATCH/v1/webhooks/{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}'

Response200

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