Logo

Documentation

  • Getting started
    • What is Eventyay?
    • Eventyay concepts
    • Quick start: create and publish an event
    • Hosted platform vs self-hosted installation
  • User guide
    • Setting up an event
      • Creating an event
      • Configure event basics
      • Configuring an event
        • Event series
        • Configuring plugins
      • Publish or unpublish an event
    • Ticketing and orders
      • Ticket settings
      • Ticket products and quotas
      • Gift cards
        • Selling gift cards
        • Accepting gift cards
        • Manually issuing or using gift cards
      • Manage orders
      • Payment settings
      • Refunds and cancellations
      • Ticket buyer experience
    • Talks, speakers, and schedules
      • Sessions and proposals
      • Sessions & Proposals
        • What is not a Session?
        • Session Lifecycle
        • Organisation Features
        • Speakers
        • Interaction & Communication
        • Scheduling Guide
        • Review Guide
        • Email Guide
        • Session Management
    • Video and online events
      • Online event pages
      • Video rooms and streaming links
    • Badges and check-in
      • Badges
      • Check-in
    • Messaging and emails
    • Imports and exports
    • Event website and public pages
      • Display settings
      • Embeddable Widget
        • Example
        • Styling
        • SSL
        • Always open a new tab
        • Pre-selecting a voucher
        • Disabling the voucher input
        • Filtering products
        • Multi-event selection
        • Eventyay Button
        • Dynamically opening the widget
        • Dynamically loading the widget
        • Waiting for the widget to load
        • Passing user data to the widget
    • Attendee guide
  • Platform administration
    • Unified Eventyay installation
      • General remarks
        • Requirements
      • Small-scale deployment with Docker
        • Requirements
        • On this guide
        • Data files
        • Database
        • Redis
        • Config file
        • Docker image and service
        • Cronjob
        • SSL
        • Next steps
        • Updates
        • Install a plugin
        • Scaling up
      • Small-scale manual deployment
        • Requirements
        • Unix user
        • Database
        • Package dependencies
        • Config file
        • Install eventyay from PyPI
        • Start eventyay as a service
        • Cronjob
        • SSL
        • Next steps
        • Updates
        • Install a plugin
    • Deployment and reverse proxy
    • Configuration
    • Eventyay platform runtime
      • Runtime components
      • Configuration model
      • Database, Redis, and background jobs
      • Persistent data and generated files
      • Email delivery
      • Startup and upgrade sequence
      • Health and operational checks
      • Security baseline
    • Operations and maintenance
    • Troubleshooting
  • Developer guide
    • Local development setup
      • Quick start with Docker
      • Python based local development
        • Mobile testing note
        • Permission note
    • Architecture overview
      • Overview
      • Architecture Principles
        • Unified Data Model
        • Component-Specific Models
        • Shared Services
      • Directory Structure
      • Authentication & Permissions
      • Database Schema
      • API Architecture
      • Plugin System
      • Frontend Architecture
      • Deployment Options
      • Environment Variables
      • Migration from Legacy Systems
      • Development Setup
      • Testing
      • Performance Considerations
      • Security
      • See Also
    • Backend development
    • Frontend development
    • Frontend Applications Overview
      • Video Web Application
        • Architecture
        • Core Application Structure
        • Key Components
        • Views
        • State Management
        • Utility Libraries
        • Internationalization
        • Styling & Theming
        • Building & Development
        • Configuration
      • Talk Component Frontend Applications
      • Development Setup
        • Prerequisites
        • Full Stack Development
        • Frontend-Only Development
        • Testing
      • Best Practices
        • Component Development
        • State Management
        • Performance
        • Accessibility
      • Troubleshooting
        • Common Issues
      • Further Reading
    • Database and migrations
    • Plugin development
    • API development
    • Testing and CI
    • Translations
    • Rich Text and Email Editors
      • Overview
      • Tiptap Editor Layer
        • Frontend Bundle (webapp/editor/)
        • Lazy Loader (static/common/js/tiptapLoader.js)
      • Django Integration
        • Widgets
        • Form Fields
        • Message Center (primary wiring)
        • Server-side Sanitization
        • Email Preview Endpoint
      • Placeholder Variables
      • Toast UI Markdown Editor (existing)
      • Quill (existing, video only)
      • Migration Path
    • Contributing
    • Release workflow
    • Release checklist (maintainer reference)
      • Boarding checks
      • System checks
      • Take-off and landing
  • API reference
    • API resources
      • Organizers
        • Resource description
        • Endpoints
        • Organizer settings
      • Events
        • Resource description
        • Endpoints
        • Event settings
      • Event series dates / Sub-events
        • Resource description
        • Endpoints
      • Tax rules
        • Resource description
        • Endpoints
      • Item categories
        • Resource description
        • Endpoints
      • Items
        • Resource description
        • Notes
        • Endpoints
      • Item variations
        • Resource description
        • Endpoints
      • Item bundles
        • Resource description
        • Endpoints
      • Item add-ons
        • Resource description
        • Endpoints
      • Questions
        • Resource description
        • Endpoints
      • Question options
        • Resource description
        • Endpoints
      • Quotas
        • Resource description
        • Endpoints
      • Orders
        • Order resource
        • Order position resource
        • Order payment resource
        • Order refund resource
        • List of all orders
        • Fetching individual orders
        • Order ticket download
        • Updating order fields
        • Generating new secrets
        • Deleting orders
        • Creating orders
        • Order state operations
        • Generating invoices
        • Sending e-mails
        • List of all order positions
        • Fetching individual positions
        • Order position ticket download
        • Manipulating individual positions
        • Order payment endpoints
        • Order refund endpoints
        • Revoked ticket secrets
      • Invoices
        • Resource description
        • Endpoints
      • Vouchers
        • Resource description
        • Endpoints
      • Check-in lists
        • Resource description
        • Endpoints
        • Order position endpoints
      • Waiting list entries
        • Resource description
        • Endpoints
      • Gift cards
        • Resource description
        • Endpoints
      • Cart positions
        • Cart position resource
        • Cart position endpoints
      • Teams
        • Team resource
        • Team member resource
        • Team invite resource
        • Team API token resource
        • Team endpoints
        • Team member endpoints
        • Team invite endpoints
        • Team API token endpoints
      • Devices
        • Device resource
        • Device endpoints
      • Webhooks
        • Resource description
        • Endpoints
      • Seating plans
        • Resource description
        • Endpoints
      • Data exporters
        • Listing available exporters
        • Running an export
        • Downloading the result
      • Eventyay Hosted billing invoices
        • Resource description
        • Endpoints
      • Eventyay Hosted reseller API
        • Reseller account resource
        • Endpoints
    • API Usage Guides
      • Understanding the life cycle of orders
        • Order states
        • Object types
      • Creating an external checkout process
        • Creating orders
        • Handling payments yourself
        • Using eventyay payment providers
        • Optional: Cart reservations
  • Reference
    • Configuration
      • Configuration Sources
      • TOML Example
      • Environment Variables Example
      • Available Settings
        • General Settings
        • Database Settings
        • Redis Settings
        • Email Settings
        • Plugins & Modules
        • Metrics & Sentry
        • Upload Limits
    • Environment variables
    • Permissions reference
      • Requiring permissions for a view
      • Requiring permissions in the REST API
      • Checking permission in code
      • Staff sessions
    • Plugin reference
      • List of plugins
      • Badges
        • Resource description
        • Endpoints
      • Bank transfer HTTP API
        • Bank import job resource
      • BitPay
      • HubSpot Integration
        • Connecting to HubSpot
        • Event HubSpot settings
        • Field mapping
        • Mapping Conflicts
        • Activity Log
        • Sync Problems
        • Order Details HubSpot Sync
        • Disconnecting
      • PayPal
      • PDF ticket output
        • Resource description
        • Endpoints
    • Management commands
      • Database commands
        • migrate
        • showmigrations
        • clearsessions
      • Debug commands
        • shell
        • print_settings
      • Core eventyay commands
        • rebuild
        • init
        • createsuperuser
        • runperiodic
        • export_schedule_html
        • create_test_event
        • move_event
      • Development commands
        • makemessages
        • makemigrations
        • create_social_apps
        • sync_customer_account
    • Data model overview
    • Glossary
    • Troubleshooting reference
Eventyay
  • Reference
  • View page source

Reference

This section contains shared factual lookup material for platform operators, developers, and integrators.

  • Configuration
    • Configuration Sources
    • TOML Example
    • Environment Variables Example
    • Available Settings
  • Environment variables
  • Permissions reference
    • Requiring permissions for a view
    • Requiring permissions in the REST API
    • Checking permission in code
    • Staff sessions
  • Plugin reference
    • List of plugins
    • Badges
    • Bank transfer HTTP API
    • BitPay
    • HubSpot Integration
    • PayPal
    • PDF ticket output
  • Management commands
    • Database commands
    • Debug commands
    • Core eventyay commands
    • Development commands
  • Data model overview
  • Glossary
  • Troubleshooting reference
Previous Next

© Copyright 2026 Apache 2.0 License by contributors.

Built with Sphinx using a theme provided by Read the Docs.