Webhooks

Update an endpoint

Changes an endpoint's URL, description, event patterns, or enabled flag. Omitted fields are left as they are.

The signing secret is not rotated and cannot be set here, so an endpoint you edit keeps verifying against the secret you already deployed.

enabled: false is the reversible way to stop deliveries — the endpoint and its delivery history survive, and flipping it back resumes without re-registering.

patch/v1/webhooks/{id}

Request

  • Base URL: https://api.volanea.com
  • URL: https://api.volanea.com/v1/webhooks/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Endpoint id.

Request body

urlstring uri
descriptionstring
eventsstring[]
enabledboolean

Response

The updated endpoint.

webhookEndpointIdstring required
projectIdstring
urlstring uri required
descriptionstring nullable
secretstring required

whsec_… — used to HMAC-SHA256-sign every delivery (X-Volanea-Signature: t=<ms>,v1=<hex> over <t>.<body>).

eventsstring[] nullable

Event name patterns, e.g. ["email.*", "contact.created"]. Empty or null = all events.

enabledboolean required
createdAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.