Events
Retrieve events that record every notable change in your VINR account.
An event is created whenever something notable changes in your VINR account — a payment succeeds, an invoice is paid, a subscription renews. Events are read-only; use webhook endpoints to receive them in real time rather than polling this API.
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 event objectAsk
idstringUnique identifier for the event, e.g. evt_9Bz1kWpA.
typestringThe event type, e.g. payment.succeeded or invoice.paid. Used as the routing key in webhook
endpoint subscriptions.
dataobjectContainer for the resource snapshot at the time the event was created.
createdtimestampUnix timestamp of when the event was created.
Retrieve an eventAsk
List eventsAsk
Returns a list of events, optionally filtered by type or creation date. Results are sorted newest
first. Use created.gte to page forward from a known timestamp rather than polling for the latest.
