Skip to main content

Events

This entity describes an event. This entity stores a substantial amount of information that is vital for the operation of menta tech. It is crucial that you provide this information as described to ensure everything functions correctly.

Attributes

FieldData TypeExampleDescriptionRequired
titleString"Drake in Concert"Event titleYes
descriptionString“Don’t miss this unique show in Argentina. Drake will perform at the River Plate Stadium…”Full description of the eventYes
externalReferenceIdString"340"The identifier used by your platform to refer to this event. Must be unique.Yes
showArray[Show]Array of shows that are part of the event. Each show includes details such as title, date, and ticket options.Yes
locationObjectSee table below.Yes
configurationObjectSee table below.No

Entity location

FieldData TypeExampleDescriptionRequired
cityString"New York City"Name of the city where the event takes place.No
stateString"New York"State or province where the event takes place.No
venueNameString"Broadway Theatre"Name of the venue where the event takes place.No
addressString"200 W 45th Street"Address of the venue where the event takes place.No
countryString"United States"Country where the event takes place.No
timeZoneString"America/New_York"Time zone of the event location.No
rawString"Broadway Theatre"Unprocessed information related to the location.No
mapObject{ "thumbnail": "URL", "googleMapsUrl": "URL" }Additional map information for the location.No

Entity configuration

FieldData TypeExampleDescriptionRequired
policyString"OPTIONAL"WillCall policy for the event. Can be "NONE", "OPTIONAL", or "MANDATORY".No
instructionsString"Present the pickup code at the theater box office."Instructions for users on how to pick up their tickets using WillCall.No
hoursBeforeShowInteger168Specifies in hours how much before the event WillCall should be available. Typically, ticketing systems allow WillCall 2 weeks before the event.No

In this table, almost all fields are primitive, except for show, which requires sending an array of the Show entity.

More about the Show entity

The Show entity allows an event to have more than one show. Read more about Show

Example of a Complete Event

Including the Show and TicketOption entities

{
"title": "The Lion King",
"description": "Over 60 million people from around the world have come to experience the excitement and discover the splendor of the incomparable musical, The Lion King.",
"externalReferenceId": "the-lion-king-broadway",
"shows": [
{
"title": "The Lion King in Broadway Theatre",
"status": "LIVE",
"images": [
{
"url": "https://storage.googleapis.com/default_mentatickets-core/dd127bc9-1079-4bbc-9bab-c87acd27edb2_SOURCE.webp",
"kind": "main"
}
],
"showId": "4726",
"date": "2022-04-02T14:00:00.000-04:00",
"ticketOptions": [
{
"title": "Standard Seat",
"ticketId": "0001",
"description": "Good view and sound. Located 40 to 60 meters from the stage.",
"price": 5500,
"currency": "ARS"
},
{
"title": "Premium Seat",
"ticketId": "0002",
"description": "Located at the front of the theater, with an excellent view and premium sound.",
"price": 13800,
"currency": "ARS"
}
]
}
],
"location": {
"city": "New York City",
"state": "New York",
"venueName": "Broadway Theatre",
"address": "200 W 45th Street",
"country": "United States"
}
}