Webhooks

Create webhook endpoint

Changed on

Returns the endpoint plus its signing secret (shown once). Event names are validated against the emit catalog — subscribing to an event Velox never emits is a 422, not silence. Omitted/empty events = all events (""); "invoice."-style prefix wildcards are supported.

post/v1/webhook-endpoints/endpoints

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/v1/webhook-endpoints/endpoints
  • Auth: HTTP bearer

Request body

urlstring required
descriptionstring
eventsstring[]

Response

Endpoint created (response carries the one-time signing secret)

Changes