Webhook endpoints
Register and manage URLs that receive VINR event notifications.
A webhook endpoint registers a URL on your server to receive event notifications from VINR. When a
notable change occurs — such as a payment succeeding or a subscription renewing — VINR sends an
HTTP POST to every matching endpoint. VINR signs each delivery using the endpoint's secret so you
can verify the payload before processing it.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The webhook endpoint objectAsk
idstringUnique identifier for the webhook endpoint, e.g. we_4Qm7vDzH.
urlstringThe destination URL that receives event payloads, e.g. https://example.com/webhooks/vinr.
statusenumOne of enabled or disabled. Disabled endpoints receive no deliveries.
enabled_eventsarrayList of event types this endpoint subscribes to, e.g. ["payment.succeeded", "invoice.paid"].
Pass ["*"] to subscribe to all events.
secretstringSigning secret used to verify delivery authenticity. Shown only on create. Use it to
validate the X-Vinr-Signature header on each incoming request.
createdtimestampUnix timestamp of when the endpoint was created.
Create a webhook endpointAsk
Register a new URL and specify which event types it should receive.
Retrieve a webhook endpointAsk
Update a webhook endpointAsk
Change the subscribed event types or toggle the endpoint active/disabled without deleting it.
Delete a webhook endpointAsk
Permanently removes the endpoint. VINR will stop sending deliveries immediately.
