Event
An event represents a scheduled activity or occasion. You can create ticket types for the event with EventTicketType.
| Property | Type | Default | Description | Example |
|---|---|---|---|---|
id* | string (UUIDv4) | Unique identifier | "bd4a0997-39db-41d9-883a-cdfa83e2101f" | |
createdAt | date | Creation timestamp of the event | "2024-01-15T09:30:00.000Z" | |
masterLanguage | string | Master language of the event | "en" | |
name* | string | Name of the event | "Summer Festival 2024" | |
description | string | Description of the event | "Annual summer celebration with music and activities" | |
startDate | date | Start date and time of the event | "2024-07-01T14:00:00.000Z" | |
endDate | date | End date and time of the event | "2024-07-03T22:00:00.000Z" | |
allDay | boolean | false | Whether the event is an all-day event | true |
parentEventId | string (UUIDv4) | If it is part of a series, then it will have a parent event id | "bd4a0997-39db-41d9-883a-cdfa83e2101f" | |
published | boolean | false | Whether the event is publicly visible. This flag is considering also planned functionality. | true |
publishedAt | date | This is optional, since the event can be published right away. But there might be a date in the future or past. So if published is set to true, then it is published. Otherwise there might be info in this field on when the event will be published | "2024-01-15T09:30:00.000Z" | |
imageId | string (UUIDv4) | null | ID of an image associated with the event | "bd4a0997-39db-41d9-883a-cdfa83e2101f" |
translations | array | [] | A list of translation objects EventTranslation for the object | [{ language: "da", title: "Sommerfestival 2024", description: "Årlig sommerfest..." }] |
enableTickets | boolean | false | Whether tickets can be issued for this event | true |
ticketTypes | array | [] | A list of ticket types (EventTicketType) associated with this event | [{ id: "bd4a0997-39db-41d9-883a-cdfa83e2101f", name: "General Admission" }] |
onSale | boolean | true | A convenience field where you can check whether the event is on sale or not. The workspace is able to set all kind of rules for when the sale will start and finish and this field will dynamiccally update and take those settings into consideration | |
saleStartsAt | date | This field is optional and might include a date for when the sale starts for this event | ||
saleEndsAt | date | This field is optional and might include a date for when the sale will end for this event | ||
soldOut | boolean | false | Whether all tickets for this event have been sold. It takes max capacities into consideration for all ticket types and for the overall event. | true |
checkoutUrl | string | The URL to the checkout page for this event. This is automatically generated based on your workspace domain. | "https://acme-museum.membership.loby.io/events/bd4a0997-39db-41d9-883a-cdfa83e2101f/checkout" | |
maxTickets | number | null | The maximum number of tickets for the event, shared by all its ticket types. Null when the event has no overall limit | 40 |
numberOfIssuedTickets | number | 0 | Number of tickets that have been issued for the event | 32 |
totalNumberOfReservedTickets | number | 0 | Number of tickets that are issued or held in an ongoing checkout. This is the number the checkout checks the capacity against | 34 |
remainingTickets | number | null | Number of tickets that can still be bought for the event, never below 0. The capacity is maxTickets, or the sum of the ticket types' maxQuantity when every ticket type has a limit and that sum is lower. Null when the event has no limit | 6 |
Capacity and remaining tickets
Each time in a series is its own event (with a parentEventId), with its own capacity. When the ticket types of an event share one pool of places, use the event's remainingTickets (or calculate maxTickets - totalNumberOfReservedTickets). A ticket type's own availableQuantity and remainingTickets are only set when that ticket type has a limit of its own. For events sold from a seating map, the remaining numbers are not based on the seats yet: use soldOut.
EventTranslation
An EventTranslation contains translated fields for the event object.
| Property | Type | Default | Description | Example |
|---|---|---|---|---|
language* | string (ISO 639-1) | Language code for the translation | "da" | |
name | string | null | See description of field in Event | "Sommerfestival 2024" |
description | string | null | See description of field in Event | "Årlig sommerfest..." |
EventTicketType
An EventTicketType represents a type of ticket that can be issued for an event.
| Property | Type | Default | Description | Example |
|---|---|---|---|---|
id* | string (UUIDv4) | Unique identifier | "bd4a0997-39db-41d9-883a-cdfa83e2101f" | |
masterLanguage | string | Master language of the event | "en" | |
name* | string | Name of the ticket type | "General Admission" | |
description | string | Description of the ticket type | "Standard entry ticket" | |
price | number | null | Price of ticket in lowest unit. Cents for EUR, USD etc. 0 = FREE | 2500 |
maxQuantity | number | null | Maximum number of tickets of this type that can be issued. Null means unlimited. | 1000 |
translations | array | [] | A list of translation objects EventTicketTypeTranslation for the object | [{ language: "da", name: "Standard billet", description: "Standard adgangsbillet" }] |
availableQuantity | number | null | maxQuantity minus the issued tickets of this type. Null when the ticket type has no limit of its own (it then shares the event's places, see remainingTickets on Event) | 850 |
soldOut | boolean | false | Whether all tickets of this type have been sold | true |
addOn | boolean | false | Whether this ticket type is an add-on. This ticket type cannot be used as admittance to the event | true |
published | boolean | false | Whether this ticket type is publicly visible | true |
numberOfIssuedTickets | number | 0 | Number of tickets of this type that have been issued | 150 |
totalNumberOfReservedTickets | number | 0 | Number of tickets of this type that are issued or held in an ongoing checkout | 152 |
remainingTickets | number | null | Number of tickets of this type that can still be bought: maxQuantity minus totalNumberOfReservedTickets, never below 0. Null when the ticket type has no limit of its own | 848 |
EventTicketTypeTranslation
An EventTicketTypeTranslation contains translated fields for the event ticket type object.
| Property | Type | Default | Description | Example |
|---|---|---|---|---|
language* | string (ISO 639-1) | Language code for the translation | "da" | |
name | string | null | See description of field in EventTicketType | "Standard billet" |
description | string | null | See description of field in EventTicketType | "Standard adgangsbillet" |