webhooks

Register a webhook endpoint

Registers a URL to receive signed event deliveries and returns it along with its signing secret. The secret is shown exactly once — store it now; afterwards you can only rotate it. The URL must be a publicly resolvable HTTPS address, and every entry in subscribed_events must be a known event type. Requires a plan that includes event webhooks. 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

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
  • Auth: HTTP bearer

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 required
urlstring required
subscribed_eventsstring[]

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.