Documentation
Everything You Need to Run the Platform Yourself.
Setup guides, compliance configuration, incident logging, API reference, and integration instructions. Written for operators who want to get on with it, and developers who need the technical depth. Documentation is maintained to the same standard as the platform - gaps are treated as defects.
Getting Started
Account creation, venue configuration, team roles, and logging your first live session. Fully operational in under 15 minutes - no onboarding call required.
Read more →API Reference
Complete REST API documentation: endpoint specifications, bearer token authentication, rate limits, webhook signatures, and error codes.
Read more →Integrations Guide
Step-by-step connection instructions for Skiddle, Square, Instagram, TikTok, Google Analytics, and custom REST integrations.
Read more →Compliance & Security
RBAC configuration, audit log access, incident log exports, GDPR subject access request handling, Data Processing Agreement guidance, and licensing authority report generation.
Read more →01
Getting Started
Account creation, venue configuration, team setup, and your first live session. A payment card is required at signup. The 14-day trial begins immediately - no charge until it ends. You do not need to speak to anyone to get set up.
Create Your Account
Sign up at holocron.scot. A payment card is required at account creation to activate your 14-day trial. No charge is applied during this period. Cancel before the trial ends and you pay nothing. Your account is ready to configure immediately.
Set Up Your Venue
Enter your venue name, address, and maximum capacity in Settings > Venue. This becomes your baseline for attendance tracking, occupancy alerts, and incident reporting. Getting this right matters - your licensed capacity should match what is on your premises licence.
Invite Your Team
Go to Settings > Team Members and add staff by email. Assign roles: Owner (full access), Manager (data entry and reporting), or Staff (data entry only). Permissions are enforced on every action - what a staff member can see and modify in the platform reflects what they should see and modify on the floor.
Start Logging Live Data
Navigate to Dashboard. Log attendance, incidents, drinks sold, and ticket sales in real time from the relevant sections. Every entry is timestamped and attributed to your account. Your first live data appears in the dashboard immediately.
Review Your First Night Report
After the night, navigate to Reports. Generate a night report covering attendance peaks, incident timeline, and revenue summary. Export as CSV or PDF. This report is your operational record for that trading session and can be used directly in licensing reviews.
02
API Reference
Holocron exposes a REST API for programmatic access to all venue and session data. All endpoints require bearer token authentication.
Authentication
Generate API tokens in Settings > API Keys. Each token is a bearer token for Authorization headers. Include as: Authorization: Bearer YOUR_TOKEN. Tokens are revocable and tied to your account. Never commit tokens to version control.
Base URL & Endpoints
All requests go to https://holocron.scot/api/v1. Core endpoints: /attendance (GET, POST), /incidents (GET, POST, PATCH), /drinks (GET, POST), /tickets (GET, POST), /reports (GET). Request and response bodies are JSON. All timestamps are UTC in ISO 8601 format.
Rate Limits
Trial accounts: 100 requests per minute. Paid accounts: 1,000 requests per minute. Rate limit headers are included in every response. Exceed the limit and you'll receive a 429 status. Retry after the window resets.
REST API Endpoints
REST API endpoints are available for data integration. Full endpoint documentation is in the API Reference section below. Contact support@holocron.scot for API access.
Error Handling
Standard HTTP status codes apply. 400: invalid request. 401: missing or invalid token. 403: insufficient permissions. 404: resource not found. 429: rate limit exceeded. 500: server error. All error responses include a code and message field for debugging.
03
Integrations Guide
Connect Holocron to your existing ticketing, POS, and social platforms. Each integration requires an API key or OAuth authorisation. All credentials are stored encrypted. Manage connections from Settings.
Skiddle
Go to Settings > Integrations > Skiddle. Enter your Skiddle API key from your promoter dashboard. Once connected, ticket sales and guest lists sync to your Holocron ticket log.
Square
Navigate to Settings > Integrations > Square. Click Authorise. Sign in with your Square account and approve data access. Once connected, drink and transaction data flows into your revenue dashboard.
Social (Instagram & TikTok)
Add Instagram and TikTok separately under Settings > Integrations. Authorise via OAuth for each platform. Grant permission for post and account insights. Once connected, follower counts and post engagement appear in your Social section. Available on Professional and Enterprise plans.
Google Analytics
Connect Google Analytics under Settings > Integrations. Authorise via OAuth to grant Holocron access to your website traffic data. Once connected, page views and conversion data populate your dashboard.
Custom Integrations
For platforms not listed above, REST API endpoints are available for data integration. Contact support@holocron.scot for API access and endpoint documentation.
04
Compliance & Security
Role-based access control, immutable audit logs, encrypted data storage, and structured compliance tooling. Built specifically to satisfy UK licensing authority requirements and GDPR obligations under the Data Protection Act 2018.
Role-Based Access Control
Three roles control permissions: Owner (all actions, settings, billing), Manager (data entry, reporting, team invite), Staff (data entry only). Assign roles when inviting team members in Settings > Team Members. Permissions are enforced on every API request and every UI action - there is no way to bypass them at the application layer.
Audit Logging
Every action - login, data entry, incident creation, report generation, settings change - is timestamped and attributed to a named user. View the audit log in Settings > Audit Log. Logs are immutable and retained for 2 years. Export at any time for licensing reviews, ICO enquiries, or internal compliance audits.
Incident Log Exports & Licensing Reviews
Go to Settings > Data Export to generate a full export of your incident log, attendance records, and session data in CSV or PDF format. Incident exports include timestamps, staff attribution, incident category, and resolution notes - structured for presentation to a licensing board or police authority. Exports are encrypted and expire after 7 days.
GDPR & Data Subject Requests
Individuals may request access to, correction of, or deletion of their personal data under UK GDPR. Submit requests to privacy@holocron.scot with your venue account email. We respond within 30 days in line with ICO guidance. Include a copy of the data subject's identification for verification.
Data Processing Agreements
A Data Processing Agreement (DPA) is available on request for all paid accounts. Email legal@holocron.scot with your account details. The DPA formally designates Holocron as a data processor, outlines data handling obligations, and satisfies the Article 28 UK GDPR requirement. Standard DPA issued within 5 business days.
Quick Links
The most commonly referenced tasks - indexed so you can find what you need quickly.
Something Missing?
If what you need is not covered here, contact us directly. Documentation gaps are treated as defects - we investigate, update the docs, and let you know.
support@holocron.scot