webhooks

Rotate an endpoint's signing secret

Issues a new signing secret and returns it. The previous secret stops verifying immediately and there is no overlap window, so deploy the new one to your receiver before rotating. The business is taken from the business-id header rather than the URL; the path-scoped form of this operation is deprecated.

post/api/v1/webhook-endpoints/{endpoint_id}/rotate-secret

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}/rotate-secret
  • 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.

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
signing_secretstring required

Changes

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