New: Certificate Designer and public speaker pages are live. See what shipped
Documentation

Everything you need to get started

Guides, API reference and walkthroughs to help you get the most out of Event Star.

Quick Start

Get your first event live in under 10 minutes. No credit card required.

  1. 1 Get your workspaceRequest a free trial on the contact page and our team sets up your workspace with you.
  2. 2 Complete your profileAdd your organisation name, logo and branding colours in Settings → Organisation Settings.
  3. 3 Create an eventClick "New Event" and fill in the details: name, date, venue and description.
  4. 4 Add ticket typesUnder the Tickets tab, add your ticket types with names, prices and quantities.
  5. 5 Publish & shareHit Publish. Copy your event URL and share it. Registrations start immediately.

Creating an Event

From the admin dashboard, click New Event and fill in the name, date, venue and description. Venues are saved with their capacity, address and maps link, so you can reuse them across events.

Every event gets a branded public page with its speakers, schedule, venue and tickets. Nothing is visible to the public until you hit Publish.

Ticket Types

Each event can have multiple ticket types. Common examples:

FieldDescription
NameThe ticket name shown to customers (e.g. "Early Bird", "VIP")
PriceIn cents (e.g. 50000 = R500.00). Set to 0 for free tickets.
QuantityTotal available. Leave blank for unlimited.
Sale windowOptional start/end dates for when this ticket is on sale.
DescriptionShort description shown on the event page.

Promo Codes

Promo codes give a percentage or fixed discount at checkout. Give each code a usage cap and an expiry date, and track which code sold what. Attendees enter the code on the event page before they pay.

Speakers & Sessions

Add speaker bios, photos and social links, drag them into order and mark featured speakers to highlight them. Then build your schedule with the session builder: time slots, rooms, session types and speaker assignments. Speakers and sessions appear on the event's public page.

Registration Flow

Attendees register through a clean, mobile-first flow:

  1. Choose tickets and quantities on the event page.
  2. Fill in one form per attendee (buy 4, fill 4 forms).
  3. Review the order before payment.
  4. Pay, and receive a confirmation with a unique QR code per ticket.

Custom Fields

Add custom registration fields to ask for dietary needs, company details or anything else you need at the door. For RSVPs, surveys and waitlists that are independent of event registration, use Custom Forms, which you can embed on your own site.

Email Confirmations

Every attendee gets an instant confirmation email with their ticket. Reminder and follow-up emails are sent automatically at the right time, and paid orders also receive their invoice by email.

QR Check-in

The check-in scanner works in any modern browser. No app to install.

For the best experience, open the scanner on a phone and allow camera access when prompted.
  1. Navigate to /check-in/scan on the check-in device
  2. Select the active event from the dropdown
  3. Point the camera at the attendee's QR code
  4. Green = valid & checked in. Red = invalid or already used.

Self Check-in

Each registration also has its own signed self check-in link. When an attendee opens it on their phone, they can check themselves in without queuing at the desk. Duplicate check-ins are blocked, and the live counter updates either way.

PayFast Setup

Payments go straight into your own PayFast account. To connect it:

  1. Open Settings → Organisation Settings and scroll to Payment Gateway.
  2. Set the active gateway to PayFast.
  3. Enter your PayFast merchant ID, merchant key and passphrase. The passphrase is set in your PayFast account under Settings → Integration.
  4. Turn on Use PayFast Sandbox while you test, and turn it off before you go live.

Invoices & VAT

Every paid order automatically generates a PDF invoice, branded with your logo and colours, and emails it to the buyer. Configure tax under Settings → Organisation Settings → Tax / VAT Configuration: turn tax on, set the label (for example VAT), the rate (15 for South African VAT) and your tax registration number. Ticket prices can be VAT-inclusive or VAT-exclusive, and you can resend or download any invoice from the admin dashboard.

API Reference

Event Star provides a RESTful API for integrating with your own systems.

# Base URL
https://your-domain.com/api/v1

# Authentication
Authorization: Bearer YOUR_API_TOKEN

Authentication

Every request is scoped to your workspace with the X-Tenant-ID header. Request a token by posting your login details, then send it as a bearer token on protected endpoints.

# Request a token
curl -X POST https://your-domain.com/api/v1/auth/login \
  -H "X-Tenant-ID: YOUR_TENANT_ID" \
  -H "Accept: application/json" \
  -d "email=YOUR_EMAIL" \
  -d "password=YOUR_PASSWORD" \
  -d "device_name=my-integration"

# The response contains {"token": "...", "user": {...}}

Endpoints marked Token + API also need API access on your plan (Pro is read-only; Business and Enterprise get full access). Without it they return a 403 with an api_access_required error.

Endpoints

All paths are relative to /api/v1.

MethodPathAccessWhat it does
POST /auth/login Public Exchange email and password for a bearer token
GET /auth/me Token The signed-in user
GET /events Public Published events for the workspace
GET /events/{slug} Public A single event
GET /events/{event}/speakers Public Speakers for an event
GET /events/{event}/sessions Public Programme sessions
GET /events/{event}/tickets Public Ticket types on sale
POST /promo-codes/validate Public Check a promo code before checkout
GET /registrations Token + API List registrations
POST /registrations Token + API Create a registration
POST /check-in Token + API Check an attendee in
GET /check-in/lookup/{qr_code} Token + API Look up a ticket by QR code
POST /events/{event}/checkout Token + API Start a checkout
GET /webhooks Token + API List webhook endpoints
POST /webhooks Token + API Register a webhook endpoint

Can't find what
you need?

Our support team replies within 24 hours on business days. The changelog and roadmap cover what moved and what is coming.

Contact support

Our support team replies within 24 hours on business days.

Contact support

What changed

Every release, dated, in plain English. Check here when something looks different.

Read the changelog

What is next

See what we are building, and tell us what would help your next event.

View the roadmap

Ready to run your first event?

Request a free trial and we will set up a workspace for you. Or book a demo and we will walk you through it.