It's a beautiful day today!
" }, }, "type": "text", "id": "12345" } ``` -------------------------------- ### GET Image Response Format Source: https://www.eventbrite.com/platform/docs/event-description This JSON structure represents the response format when retrieving image details. It includes aspect ratio, corner style, edge color, and URLs for original and cropped images. ```json { "data": { "image": { "aspect_ratio": "1.67" "corner_style": "rectangular" "crop_mask": {} "edge_color": "#77634e" "edge_color_set": true "id": "85619535" "image_id": "85619535" "original": { "url": "https://img.evbuc.com/etc", "width": 604, "height": 453 }, "url": "https://img.evbuc.com/etc" }, "id": "29657266", "type": "image", } ``` -------------------------------- ### Eventbrite Livestream Module GET Response Format Source: https://www.eventbrite.com/platform/docs/online-event-page Provides the JSON response format for retrieving Livestream module data from Eventbrite. It mirrors the webinar module's structure, including image details, livestream URL, title, and instructions. ```json { "id":"32551553", "type":"livestream", "data":{ "image":{ "edge_color_set":true, "edge_color":"#d0c9bd", "corner_style":"rectangular", "url":"https://img-dev.evbuc.com/3765", "original":{ "url":"https://img-dev.evbuc.com/3765", "width":1200, "height":650 }, "image_id":"63131771", "crop_mask":{ "width":1148, "top_left":{ "y":2, "x":26 }, "height":646 }, "aspect_ratio":"1.7", "id":"63131771" }, "livestream_url":{ "url":"http://zoom.us/1234", "text":"my livestream" }, "title":{ "text": "Optional Title", }, "instructions":{ "text": "Instructions to join the livestream", } }, } ``` -------------------------------- ### User Information Response (Eventbrite API) Source: https://www.eventbrite.com/platform/docs/api-explorer This is an example of the JSON response received when querying the `/users/me/` endpoint of the Eventbrite API. It includes the user's email addresses, unique ID, full name, first name, and last name. ```json { "emails": [ { "email": "andrewgodwin@eventbrite.com", "verified": false, "primary": true } ], "id": 85329145958, "name": "Andrew Godwin", "first_name": "Andrew", "last_name": "Godwin" } ``` -------------------------------- ### Create Eventbrite Ticket Class with Inventory Tier Source: https://www.eventbrite.com/platform/docs/ticket-classes This example demonstrates the JSON structure for creating a ticket class and linking it to an existing inventory tier. It specifies ticket details like name, cost, quantity, sales dates, and the inventory tier ID. ```JSON { "ticket_class": { "name": "Booth", "free": false, "donation": false, "quantity_total": "", "minimum_quantity": "1", "maximum_quantity": "10", "cost": "USD,2000", "hidden": false, "auto_hide": false, "auto_hide_before": "", "auto_hide_after": "", "sales_channels": ["online","atd"], "hide_sale_dates": false, "delivery_methods": ["electronic"], "inventory_tier_id": "520007", "include_fee": false, "sales_start": "2019-12-09T08:00:00Z", "sales_end": "2021-02-01T03:00:00Z" } } ``` -------------------------------- ### Authenticate Eventbrite API Requests Source: https://www.eventbrite.com/platform/docs/authentication This section outlines the process of authenticating API requests to the Eventbrite platform. It emphasizes the need for a valid OAuth token for all interactions. The steps involve obtaining a private token and then using it to authenticate subsequent API calls. ```HTTP GET /v3/events/search?token=YOUR_PRIVATE_TOKEN Host: www.eventbriteapi.com ``` -------------------------------- ### Expand Ticket Classes for Event Source: https://www.eventbrite.com/platform/docs/events This snippet shows how to retrieve detailed information about an event's ticket classes by using the 'expand=ticket_classes' parameter in a GET request to the Eventbrite API. It includes an example of the expected JSON response containing ticket class details. ```curl curl -X GET https://www.eventbriteapi.com/v3/events/{event_id}/?expand=ticket_classes -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' ``` -------------------------------- ### List Events by Date Source: https://www.eventbrite.com/platform/docs/events Retrieve a list of events based on their start date using the 'time_filter' parameter. This allows filtering for past, current/future, or all events. ```curl curl -X GET https://www.eventbriteapi.com/v3/organizations/{organization_id}/events/?time_filter=current_future -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' ``` -------------------------------- ### Retrieve Basic Event Summary Source: https://www.eventbrite.com/platform/docs/event-description Fetches basic event information, including the event summary which is available under the 'description' field. This endpoint provides core details about an event, such as its name, description, ID, and URL. ```bash curl -X GET https://www.eventbriteapi.com/v3/events/{event_id} -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' ``` -------------------------------- ### POST Video Module Format Source: https://www.eventbrite.com/platform/docs/event-description This JSON structure is used to create a video module, supporting YouTube and Vimeo links. It specifies the video URL and the desired display size. ```json { "data": { "video": { "url": "https://www.youtube.com/watch?v=-pAz5X7ZW4", "display_size": "large" } }, "type": "video" } ``` -------------------------------- ### List Events by Status Source: https://www.eventbrite.com/platform/docs/events Obtain a list of events filtered by their status (draft, live, started, ended, canceled) using the 'status' parameter in the organization's events endpoint. ```curl curl -X GET https://www.eventbriteapi.com/v3/organizations/{organization_id}/events/?status=live -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' ``` -------------------------------- ### Retrieve Event Structured Content Source: https://www.eventbrite.com/platform/docs/event-description Fetches the latest published version of structured content for an event, including a full list of modules. It's recommended to set the 'purpose' parameter to 'listing' for event descriptions. The response includes resource URIs, page version, purpose, a list of modules (text, image, video), and pagination details. ```bash curl -X GET https://www.eventbriteapi.com/v3/events/{event_id}/structured_content/?purpose=listing -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' ``` -------------------------------- ### Eventbrite API - Push Data (POST/DELETE) Source: https://www.eventbrite.com/platform/docs/introduction This snippet describes how to use POST and DELETE requests with the Eventbrite API to manage events, ticket classes, venues, and order questions. It covers creating, updating, deleting, publishing, and unpublishing various event-related data. ```HTTP POST /events DELETE /events/{id} POST /events/{id}/ticket_classes DELETE /events/{id}/ticket_classes/{ticket_class_id} POST /venues DELETE /venues/{id} POST /orders/{id}/questions UPDATE /orders/{id}/questions/{question_id} ``` -------------------------------- ### Event Response with Ticket Classes Source: https://www.eventbrite.com/platform/docs/events This is an example of the JSON response from the Eventbrite API when requesting expanded ticket class information for an event. It details the structure of the 'ticket_classes' array, including properties like name, quantity, and sales status. ```json { ... "ticket_classes": [ { "resource_uri": "https://www.eventbriteapi.com/v3/events/12345/ticket_classes/12345/", "variant_id": null, "name": "test", "description": null, "donation": false, "free": true, "minimum_quantity": 1, "maximum_quantity": null, "maximum_quantity_per_order": 10, "maximum_quantity_per_order_without_pending": null, "on_sale_status": "AVAILABLE", "quantity_total": 100, "quantity_sold": 23, "sales_start": "2018-11-21T21:25:00Z", "sales_end": "2019-06-01T04:00:00Z", "hidden": false, "include_fee": false, "split_fee": false, "hide_description": true, "auto_hide": false, "variants": [], "has_pdf_ticket": true, "sales_channels": [ "online", "atd" ], "delivery_methods": [ "electronic" ], "event_id": "12345", "id": "12345" }, ... ], ... ``` -------------------------------- ### List Events by Venue Source: https://www.eventbrite.com/platform/docs/events Get a list of all events associated with a specific venue by making a GET request to the venues endpoint with the venue ID. ```curl curl -X GET https://www.eventbriteapi.com/v3/venues/{venue_id}/events/ -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' ``` -------------------------------- ### Get Organization ID - Eventbrite API Source: https://www.eventbrite.com/platform/docs/events This snippet demonstrates how to find your organization ID using the Eventbrite API. You need to provide your OAuth token for authentication. ```bash curl -X GET https://www.eventbriteapi.com/v3/users/me/organizations/ -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' ``` -------------------------------- ### Eventbrite Webinar Module POST Format Source: https://www.eventbrite.com/platform/docs/online-event-page Defines the JSON structure for creating or updating a Webinar module in Eventbrite. It includes optional fields for a webinar URL, a custom preview image (via image_id), a title, and instructions. ```json { "data":{ "webinar_url":{ "text":"my webinar", "url":"http://zoom.us/1234" }, "image":{ "type":"image", "image_id":"63131771" }, "title":{ "text": "Optional Title", }, "instructions":{ "text": "Instructions to join the webinar", } }, "type": "webinar" } ``` -------------------------------- ### Set Event Summary Source: https://www.eventbrite.com/platform/docs/event-description This cURL command shows how to set the event summary, which is a short explanation of the event with rich HTML. It requires the event ID and an authorization token. ```curl curl -X POST https://www.eventbriteapi.com/v3/events/{event_id} -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' -H "Accept: application/json" -d '{ "event":{ "descrption":{ "html": "I'm the event summary" }, } ' ``` -------------------------------- ### Get Event Ticket Availability Source: https://www.eventbrite.com/platform/docs/events Fetch information about an event's ticket availability by expanding the 'ticket_availability' parameter. This provides details on whether tickets are available, pricing, and sales dates. ```curl curl -X GET https://www.eventbriteapi.com/v3/events/{event_id}/?expand=ticket_availability -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' ``` -------------------------------- ### Get Event Category Information Source: https://www.eventbrite.com/platform/docs/events Retrieve the category of an event by expanding the 'category' parameter in the request URL. This returns a Category object containing details like ID, name, and resource URI. ```curl curl -X GET https://www.eventbriteapi.com/v3/events/{event_id}/?expand=category -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' ``` -------------------------------- ### Get Events by Organization ID - Eventbrite API Source: https://www.eventbrite.com/platform/docs/events This snippet shows how to retrieve a list of events associated with a specific organization using the Eventbrite API. It requires your organization ID and an OAuth token for authorization. ```bash curl -X GET https://www.eventbriteapi.com/v3/organizations/{organization_id}/events/ -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' ``` -------------------------------- ### Retrieve Event Ticket Classes - Eventbrite API Source: https://www.eventbrite.com/platform/docs/ticket-classes To get information about an event's ticket classes, append the 'expand=ticket_classes' parameter to your GET request URL. This allows you to retrieve details for all ticket types associated with a specific event. ```HTTP GET https://www.eventbriteapi.com/v3/events/EVENT_ID/?expand=ticket_classes ``` -------------------------------- ### Create/Update Structured Content Source: https://www.eventbrite.com/platform/docs/event-description This cURL command demonstrates how to create or update structured content for an event. It includes text, image, and video modules, along with publish and purpose flags. The API is versioned and works as an insert-only system. ```curl curl -X POST https://www.eventbriteapi.com/v3/events/{event_id}/structured_content/{version_number} -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' -H "Accept: application/json" -d '{ "modules":[ { "type":"text", "data":{ "body":{ "type":"text", "text":"It's a beautiful day today!
", "alignment":"left" } } }, { "type":"image", "data":{ "image":{ "type":"image", "image_id":"8561955" } } }, { "type":"video", "data":{ "video":{ "url":"https://www.youtube.com/watch?v=-pAz5X7ZW4", "display_size":"large" } } } ], "publish":true, "purpose":"listing" }' ``` -------------------------------- ### Authenticate API Request - Query Parameter Source: https://www.eventbrite.com/platform/docs/authentication This demonstrates how to include a private token as a query parameter at the end of an API request URL. Replace 'MYTOKEN' with the actual private token. ```URL /v3/users/me/?token=MYTOKEN ``` -------------------------------- ### Eventbrite API: Replace Batch Endpoint Source: https://www.eventbrite.com/platform/docs/changelog The Eventbrite API batch endpoint (GET /v3/batch/) will be end-of-life on November 31st, 2020. Users should replace batch requests with individual API calls. ```HTTP GET /v3/batch/ ``` -------------------------------- ### Initialize Eventbrite Frame API Source: https://www.eventbrite.com/platform/docs/integrate-your-app This snippet demonstrates how to initialize the Eventbrite Frame API by calling `EB.FrameAPI.init()`. This signals to the Eventbrite container that your app is ready, allowing it to properly size the iframe. ```javascript EB.FrameAPI.init(); ``` -------------------------------- ### POST File Module with Relative Timed Display and Notifications Source: https://www.eventbrite.com/platform/docs/online-event-page This JSON payload demonstrates how to configure a file module with relative timed display and enable notifications for attendees when the module becomes available. The 'should_notify' flag is set to true. ```json { "type":"file", "data":{ "file_url":{ "url":"https://docs.eventbrite.com/document", "text":"Presentation" } }, "timed_display":{ "relative_start":"30", "relative_end":"60", "should_notify": true } } ``` -------------------------------- ### Publish Event Source: https://www.eventbrite.com/platform/docs/create-events Publishes an event, making it accessible to attendees. This API call requires the event ID and an authorization token. ```bash curl -X POST https://www.eventbriteapi.com/v3/events/{event_id}/publish/ -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' ``` -------------------------------- ### Retrieve Event HTML Description Source: https://www.eventbrite.com/platform/docs/event-description Retrieves the event summary and structured content combined as a single HTML block. This endpoint is useful for displaying the full event description in a formatted manner. The response contains a 'description' field with the HTML content. ```bash curl -X GET https://www.eventbriteapi.com/v3/events/{event_id}/description/ -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' ``` -------------------------------- ### Get All Attendees for an Order Source: https://www.eventbrite.com/platform/docs/attendees Retrieves all attendees associated with a specific order ID. This is useful when an order includes multiple tickets for different attendees. Requires the order ID and an authorization token. ```bash curl -X GET https://www.eventbriteapi.com/v3/orders/{order_id}/attendees/ -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' ``` -------------------------------- ### Eventbrite External File Module POST Format Source: https://www.eventbrite.com/platform/docs/online-event-page Shows the JSON format for the External File module, used for linking to externally hosted files like documents or presentations. It requires a file URL and an optional text label. ```json { "type":"file", "data":{ "file_url":{ "text":"Presentation", "url":"https://docs.eventbrite.com/document" } } } ``` -------------------------------- ### Exchange Access Code for Token (cURL) Source: https://www.eventbrite.com/platform/docs/authentication This cURL command demonstrates how to make a POST request to the Eventbrite token endpoint to exchange an access code for a private token. It includes the grant type, API key, client secret, access code, and redirect URI. ```cURL curl --request POST --url 'https://www.eventbrite.com/oauth/token' --header 'content-type: application/x-www-form-urlencoded' --data grant_type=authorization_code --data 'client_id=API_KEY --data client_secret=CLIENT_SECRET --data code=ACCESS_CODE --data 'redirect_uri=REDIRECT_URI' ``` -------------------------------- ### Eventbrite API Order Response Structure Source: https://www.eventbrite.com/platform/docs/cancelling-and-refunding-orders This is an example of the JSON response structure when querying for orders via the Eventbrite API. It includes pagination details and an 'orders' array which contains the order data. ```json { "pagination": { "object_count": 6, "page_number": 1, "page_size": 50, "page_count": 1, "has_more_items": false }, "orders": [ ... ] } ``` -------------------------------- ### Get Attendees by Status Source: https://www.eventbrite.com/platform/docs/attendees Fetches attendees for an event, filtered by their status such as 'attending', 'not_attending', or 'unpaid'. This allows for targeted data retrieval based on event check-in status. Requires the event ID and an authorization token. ```bash curl -X GET https://www.eventbriteapi.com/v3/events/{event_id}/attendees?status=attending -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' ```