webhooks

Update a webhook endpoint

Changes an endpoint's URL, label, subscribed events or enabled state; omitted fields are left alone. Re-enabling an endpoint also clears the consecutive-failure streak that auto-disabled it, so a single later failure will not disable it again. The business is taken from the business-id header rather than the URL; the path-scoped form of this operation is deprecated.

patch/api/v1/webhook-endpoints/{endpoint_id}

Request

  • Base URL: https://api.izap.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.izap.ai/api/v1/webhook-endpoints/{endpoint_id}
  • Auth: HTTP bearer

Path parameters

endpoint_idstring uuid required

Headers

business-idstring nullable required

UUID of the business the request is scoped to. Required on this route; the deprecated /businesses/{business_id}/... form takes it from the path instead.

Request body

labelstring nullable
urlstring nullable
subscribed_eventsstring[] nullable
enabledboolean nullable

Response

Successful Response

idstring uuid required
labelstring required
urlstring required
subscribed_eventsstring[] required
enabledboolean required
consecutive_failuresinteger required
last_errorstring nullable required
last_delivery_atstring date-time nullable required
createdstring date-time required

Changes

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