Quickstart

From a new key to a paid order in six steps. You need to be an admin of a company on EOS, and about ten minutes.

1. Make a key

  1. Sign in to EOS and open Settings, then API keys. Only admins see it.
  2. Press Create API key, name it after the system that will use it (for example Website), and under Start from choose Ticket sales on your website. That ticks five permissions: read the company, read events, create checkouts, read orders and read guests.
  3. Choose when it expires, then Create key.
  4. Copy the key straight away. It starts eos_sk_ and is shown once: EOS keeps only a fingerprint of it. Put it in your server’s environment as EOS_API_KEY.

2. Check it works

Request
curl "https://eos.aveoevents.com/api/v1" \
  -H "Authorization: Bearer $EOS_API_KEY"

The answer names your company, the key’s permissions and its expiry. A 401 means the key was not sent whole; see key errors.

3. List your events

Published events come back soonest first. Add expand=ticket_types to get each event’s ticket types, whose id you need for the next step.

Request
curl "https://eos.aveoevents.com/api/v1/events?expand=ticket_types&limit=10" \
  -H "Authorization: Bearer $EOS_API_KEY"
One event in the list
{
  "object": "event",
  "id": 41,
  "slug": "example-night",
  "title": "Example Night",
  "status": "on_sale",
  "published": true,
  "category": "music",
  "starts_at": "2026-12-05T19:00:00.000Z",
  "ends_at": "2026-12-05T23:30:00.000Z",
  "timezone": "Europe/London",
  "currency": "GBP",
  "price_from": 26,
  "summary": "An evening of live music.",
  "description": "Doors at 7pm.\n\nOver 18s only.",
  "venue": {
    "name": "Example Hall",
    "address": "1 Example Street, London"
  },
  "image_url": "https://eos.aveoevents.com/s/acme-events/uploads/hero.jpg",
  "url": "https://eos.aveoevents.com/acme-events/events/example-night",
  "gates": [
    {
      "id": "main",
      "name": "Main entrance",
      "allow": []
    },
    {
      "id": "vip",
      "name": "VIP door",
      "allow": [
        "vip",
        "guest",
        "artist",
        "press",
        "staff",
        "crew",
        "security"
      ]
    }
  ],
  "reentry": true,
  "ticket_types": [
    {
      "object": "ticket_type",
      "id": 9001,
      "name": "General admission",
      "price": 25,
      "on_sale": true,
      "sold_out": false,
      "remaining": 180,
      "…": "…"
    }
  ]
}

4. Hold tickets

Create a checkout session with the event and what the buyer chose. EOS holds those tickets until the session’s expires_at, usually 15 minutes, so nobody else can buy them. Send an Idempotency-Key so a retried request never holds them twice.

Request
curl -X POST "https://eos.aveoevents.com/api/v1/checkout/sessions" \
  -H "Authorization: Bearer $EOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"event_id":41,"items":[{"ticket_type_id":9001,"quantity":2}],"metadata":{"basket":"8812"}}'
201 response
{
  "object": "checkout_session",
  "id": "cs_9f2c4e1a7b3d5f8e0a6c2b4d",
  "status": "open",
  "event_id": 41,
  "order_id": "O-7KQ2M4X",
  "url": "https://eos.aveoevents.com/acme-events/checkout-link/eyJhbGciOi...",
  "expires_at": "2026-11-20T10:30:00.000Z",
  "currency": "GBP",
  "amount_items": 50,
  "booking_fee": 1,
  "booking_fee_payer": "buyer",
  "amount_total": 51,
  "discount_code": null,
  "items": [
    {
      "ticket_type_id": 9001,
      "product_id": 812,
      "name": "General admission",
      "quantity": 2,
      "unit_price": 25,
      "total": 50,
      "price_before_discount": null
    }
  ],
  "payment": null,
  "metadata": {
    "basket": "8812"
  },
  "created_at": "2026-11-20T10:15:00.000Z"
}

5. Send the buyer to pay

The simplest way: redirect the buyer to the session’s url. It opens your company’s own EOS checkout with the tickets already in it, takes their details and card, and emails their tickets. Nothing about the card ever touches your server.

Want the checkout on your own page instead? Complete the session with the buyer’s details and take the card with Stripe’s Payment Element. The selling guide shows both ways in full.

// Express: after creating the session
res.redirect(303, session.url);

6. Hear about the order

Add a webhook endpoint for order.paid and EOS calls your server the moment the payment arrives, with the whole order. This needs a key with the Manage webhook endpoints permission: make a second key for it, or add the permission on the API keys page. Keep the secret from the answer: it is how you check each call really came from EOS.

Request
curl -X POST "https://eos.aveoevents.com/api/v1/webhook-endpoints" \
  -H "Authorization: Bearer $EOS_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"url":"https://example.com/hooks/eos","description":"Orders into our CRM","events":["order.paid","order.refunded"]}'

Then follow checking signatures. That is everything: from here, the reference has every endpoint.