Although we generally do not recommend it due its potential for complexity, you can use your external management system as a source of truth for film and event records in Eventive.
You can use the Eventive API to read, create, and update film and events in Eventive. You will need to include an x-api-key header to authenticate your requests; you can acquire an API key from your API keys page.
Create & update films
POST https://api.eventive.org/films [CREATE NEW]
POST https://api.eventive.org/films/<ID> [UPDATE EXISTING]
{
"event_bucket": "5a1cebde1933f10014ed3a6c",
"name": "Test Film",
"details": {
"year": "",
"runtime": "",
"language": "",
"country": "",
"premiere": "",
"rating": "",
"note": ""
},
"credits": {
"director": "",
"screenwriter": "",
"producer": "",
"executive_producer": "",
"co_producer": "",
"filmmaker": "",
"cast": "",
"cinematographer": "",
"editor": "",
"animator": "",
"production_design": "",
"composer": "",
"sound_design": "",
"music": ""
},
"tags": [
"5a1ceb9d1883f10014df39f7" // array of tag ids
],
"trailer_url": "https://trailer.com/12345",
"description": "<p>This is a description!</p>",
"short_description": "Plaintext description.",
"visibility": "visible"
}
The response JSON payload will include an id field that can be used to referred to the film in the future (e.g. to update it).
Create & update events
POST https://api.eventive.org/events [CREATE NEW]
POST https://api.eventive.org/events/<ID> [UPDATE EXISTING]
{
"event_bucket": "5a1cebde1933f10014ed3a6c",
"name": "Test Event",
"films": [
"5a1cebde1883f10014ed3a6c" // array of film ids
],
"description": "<p>This is my description!</p>",
"short_description": "This is my plaintext description.",
"venue": "5a1cebde1883f10014df3a6c", // venue id
"start_time": "2020-01-01T21:00:00.000Z",
"end_time": "2020-01-02T00:00:00.000Z",
"trailer_url": "https://trailer.com/12345",
"visibility": "visible",
"tags": [
"5a1ceb9d1883f10014df39f7", // array of tag ids
"5a20e969d14bfd0014eda1ad"
]
}
The response JSON payload will include an id field that can be used to referred to the event in the future (e.g. to update it).
Fetching existing events and films
You can retrieve existing events and films for an event bucket. You can filter the list of events/films returned using a variety of parameters.
Get existing films
GET https://api.eventive.org/event_buckets/<EVENT_BUCKET_ID>/films
Get existing events
GET https://api.eventive.org/event_buckets/<EVENT_BUCKET_ID>/events
To retrieve only specific events, you can use the event_ids parameter.
GET https://api.eventive.org/event_buckets/<EVENT_BUCKET_ID>/events?event_ids=["EVENT_ID_1","EVENT_ID_2","EVENT_ID_3",...]
To retrieve all showtimes of a film, you can use the film condition.
GET https://api.eventive.org/event_buckets/<EVENT_BUCKET_ID>/events?conditions={"film":"FILM_ID"}Note: We recommend performing these requests on the client-side, to reduce the amount of content you have to cache on your end. Performing these requests client-side will also allow you to dynamically inject customer-specific data, for example the number of tickets they have purchased to a particular showing. Learn more about our client-side API wrapper.
Sample "get film" API response
GET https://api.eventive.org/films/5a1ceb9d1883f10014df39f6
{
"id": "5a1ceb9d1883f10014df39f6",
"event_bucket": "5a1ceb2a1883f10014df39d6",
"name": "A Ballerina's Tale",
"sort_key": "Ballerina's Tale, A",
"short_description": "",
"description": "<p>A feature documentary on African American ballerina Misty Copeland that examines her prodigious rise, her potentially career ending injury alongside themes of race and body image in the elite ballet world.</p>",
"cover_image": "https://eventive.imgix.net/15550230139913ae71abcb18377628c6d.jpg",
"poster_image": "https://eventive.imgix.net/15550230043131baa1d57978707eb8c35.jpg",
"trailer_url": "https://www.youtube.com/watch?v=6Y2h6fz2XzQ",
"public_url": "https://funfilmfest.eventive.org/films/5a1ceb9d1883f10014df39f6",
"unballoted": false,
"details": {
"runtime": "85"
},
"credits": {
"cast": "Misty Copeland",
"producer": "Leslie Norville",
"director": "Nelson George"
},
"tags": [
{
"id": "5a1ceb9d1883f10014df39f7",
"name": "Documentary Feature",
"color": "#3697ff"
}
],
"visibility": "visible",
"created_at": "2017-11-28T04:52:45.479Z",
"updated_at": "2019-07-08T19:29:58.597Z"
}Sample "get event" API response
GET https://api.eventive.org/events/5a1cebde1883f10014df3a7b
{
"id": "5a1cebde1883f10014df3a7b",
"event_bucket": "5a1ceb2a1883f10014df39d6",
"timezone": "America/Chicago",
"name": "A Ballerina's Tale",
"description": "",
"short_description": "",
"location": "Regal Cinemas 1",
"venue": {
"id": "5a1cebde1883f10014df3a6c",
"name": "Regal Cinemas 1",
"color": "#cef2ec",
"use_reserved_seating": false
},
"start_time": "2020-10-07T22:30:00.000Z",
"end_time": "2020-10-08T00:00:00.000Z",
"tags": [],
"visibility": "visible",
"hide_tickets_button": false,
"require_mailing_address": false,
"rush_line_enabled": true,
"passholder_ticket_required": true,
"standalone_ticket_sales_enabled": true,
"standalone_ticket_sales_unlocked": false,
"sales_disabled_unless_coupon": false,
"trailer_url": "",
"disable_pass_quick_order": false,
"credits_disabled": false,
"tickets_available": true,
"unlimited": false,
"quantity": 120,
"ticket_buckets": [
{
"id": "5a1cebde1883f10014df3a7c",
"name": "General Admission",
"price": 1000,
"unlimited": false,
"quantity": 100,
"quantity_sold": 28,
"quantity_scanned": 0,
"quantity_remaining": 72,
"public": true,
"exclude_capacity": false,
"lock_admin_only": false,
"variants": [
{
"id": "5ca79512e05b9a002fdc8afc",
"name": "Student/Senior",
"price": 800
}
],
"applicable_pass_buckets": [],
"pass_adjusted": {}
},
{
"id": "5ca795140d16820035282bdd",
"name": "Dinner & a movie",
"price": 5000,
"unlimited": false,
"quantity": 20,
"quantity_sold": 0,
"quantity_scanned": 0,
"quantity_remaining": 20,
"public": true,
"exclude_capacity": false,
"lock_admin_only": false,
"variants": [],
"applicable_pass_buckets": [],
"pass_adjusted": {}
}
],
"films": [
{
"id": "5a1ceb9d1883f10014df39f6",
"event_bucket": "5a1ceb2a1883f10014df39d6",
"name": "A Ballerina's Tale",
"sort_key": "Ballerina's Tale, A",
"short_description": "",
"description": "<p>A feature documentary on African American ballerina Misty Copeland that examines her prodigious rise, her potentially career ending injury alongside themes of race and body image in the elite ballet world.</p>",
"cover_image": "https://eventive.imgix.net/15550230139913ae71abcb18377628c6d.jpg",
"poster_image": "https://eventive.imgix.net/15550230043131baa1d57978707eb8c35.jpg",
"trailer_url": "https://www.youtube.com/watch?v=6Y2h6fz2XzQ",
"public_url": "https://funfilmfest.eventive.org/films/5a1ceb9d1883f10014df39f6",
"unballoted": false,
"details": {
"runtime": "85"
},
"credits": {
"cast": "Misty Copeland",
"producer": "Leslie Norville",
"director": "Nelson George"
},
"tags": [
{
"id": "5a1ceb9d1883f10014df39f7",
"name": "Documentary Feature",
"color": "#3697ff"
}
],
"visibility": "visible",
"created_at": "2017-11-28T04:52:45.479Z",
"updated_at": "2019-07-08T19:29:58.597Z"
}
],
"public_url": "https://funfilmfest.eventive.org/schedule/5a1cebde1883f10014df3a7b",
"updated_at": "2018-10-12T05:17:14.819Z",
"images": {},
"rules": [],
"_other_events": []
}