Base address
Every path below starts at https://eos.aveoevents.com/api/v1. Send your key in the Authorization header and JSON in the body. The same reference is available as an OpenAPI 3.1 document for code generators, Postman and Insomnia.
The API key
Who you are, what your key may do, and the company it belongs to. Open the api key.
Events
Your events with their dates, venue and ticket types, and live availability. Open events.
Checkout
Sell tickets from your own site: hold them, take the buyer's details, then payment. Open checkout.
Orders
Every order, paid or not: read them, cancel, refund, mark paid and resend tickets. Open orders.
Guests
Ticket holders for an event: names, emails, ticket types and whether they are inside. Open guests.
Check-ins
Scan tickets in and out from your own door app, with gates and re-entry. Open check-ins.
Discount codes
Codes buyers type at checkout, on one event or many. Open discount codes.
Enquiries
Messages from your own contact form, straight into Customer cases. Open enquiries.
Reports
Sales by day for one event or all of them. Open reports.
Webhook endpoints
Addresses EOS calls when something happens, signed so you can trust them. Open webhook endpoints.
- GET
/webhook-endpointsList endpoints - POST
/webhook-endpointsAdd an endpoint - GET
/webhook-endpoints/{id}Get an endpoint - PATCH
/webhook-endpoints/{id}Change an endpoint - DELETE
/webhook-endpoints/{id}Remove an endpoint - POST
/webhook-endpoints/{id}/roll-secretRoll the signing secret - POST
/webhook-endpoints/{id}/testSend a test event - GET
/webhook-endpoints/{id}/deliveriesList deliveries - POST
/webhook-endpoints/{id}/deliveries/{delivery_id}/retryRetry a delivery
Objects
What the endpoints answer with. Every object says what it is in its object field.
- CompanyThe company the key belongs to.
- EventAn event with its dates, venue and, when asked for, its ticket types.
- Ticket typeOne price of a ticket for an event, with live availability.
- Checkout sessionTickets held for a buyer, from the moment you choose them until the order is placed or the hold ends.
- OrderAn order and its tickets.
- GuestOne ticket and the person holding it.
- Check-inA scan at the door and what happened.
- Discount codeA code buyers type at checkout. One code can work on many events.
- Webhook endpointAn address EOS sends signed events to.
- Webhook deliveryOne event sent (or being sent) to one endpoint.