• Resolved Tim

    (@tjalexander70)


    I received this email:

    We’re writing to inform you that we will be making a breaking change to our API related to our Event object and the way we handle event descriptions. If you have an integration that uses the Eventbrite API, you may need to have a developer implement these changes.

    What’s changing?

    The Event object we use currently has both a summary field and a description field. Both fields currently hold the same data: A brief summary of an event no longer than 140 characters. We will be removing the description field from the Event object, and will instead only accept requests and send responses with the optional summary field. The benefit of this change is to simplify creating events through our API and reduce the confusion that comes with having two fields with the same purpose.

    When do these changes take effect?

    Beginning March 1st, 2021 any API requests which read or write to the ‘event.description’ field will return an error.

    Which endpoints are impacted?

    Retrieve an Event by ID: GET /v3/events/:event_id/
    Create an Event: POST /v3/organizations/:organization_id/events/
    Update an Event: POST /v3/events/:event_id/
    List Events by Venue: GET /v3/venues/:venue_id/events/
    List Events by Organization: GET /v3/organizations/organization_id/events/
    List Events by Series: GET /v3/series/event_series_id/events/

    What changes need to be made?

    Ensure that your application can handle API requests and responses which include the ‘event.summary’ field
    If you are currently using the ‘description.text’ or ‘description.html’ fields of the Event object, use the event.summary field (plain text and limited to 140 chars) instead
    Ensure you are retrieving the full HTML event description content (formerly ‘event.description.html’) by calling the /v3/events/:id/description/ endpoint
    If you are not already doing so, implement the use of Structured Content to create the event description content as detailed below

    How to add an in-depth description to an event:

    Eventbrite no longer stores the full HTML description as a field on the Event object. Full HTML descriptions are created and updated using Structured Content modules. For a complete guide to this process, please review this page.

    You can find more information about these changes and any future API changes in our changelog.

    If you have questions, please post them in the Eventbrite Developers community support forum.

    Regards,
    The Eventbrite API Team

    I’m sure you are, but wanted to make sure you were aware of these changes.

Viewing 1 replies (of 1 total)
Viewing 1 replies (of 1 total)
  • The topic ‘Eventbrite API Notification: Event Description Breaking Change’ is closed to new replies.