Skip to main content

API updates

Your API version controls the API and webhook behavior you see (for example, what properties you see in responses, what parameters you’re permitted to send in requests, and so on). You need to pass the version explicitly with every request, otherwise the latest version of API is used. When a breaking change is introduced to the Workshop Butler API, a new dated version is released.

Backwards-compatible changes​

We consider the following changes to be backwards-compatible:

  • Adding new API resources.
  • Adding new optional request parameters to existing API methods.
  • Adding new properties to existing API responses.
  • Changing the order of properties in existing API responses.
  • Changing the length or format of opaque strings, such as object IDs, error messages, and other human-readable strings.
  • Adding new event types. Your webhook listener should gracefully handle unfamiliar event types.

Changelog​

The API changelog only lists breaking changes to the Workshop Butler API. If you’re looking for information about feature additions and product updates, see the product changelog.

2021-09-26​

  • On Event:
    • The property tickets.paid.vat_amount was renamed to tax_rate attribute.
    • The property tickets.paid.vat_excluded was renamed to tax_excluded attribute.
    • A new property tickets.paid.tax_validation was added. It indicates whether the VAT validation is active for the account and should be implemented during the registration phase.
    • The property tickets.paid.types[n].vat_excluded was removed. Use the property tickets.paid.tax_excluded instead as it is only possible to activate tax for all ticket types at once.
    • A new property tickets.paid.types[n].tax was added that shows the tax amount in cents.

2021-06-18​

New, fully customizable evaluation forms were added to Workshop Butler, and the API was updated to reflect this change.

  • The properties question_1, question_2, question_3, question_4, question_5, question_6, question_7, question_8, question_9 and question_10 were removed from Evaluation object.
  • The properties rating, review, created, consent, content, testimonial were added to Evaluation object.

For more information, check the Evaluation object description.

2021-01-12​

  • The property active was removed the Trainer object.

2020-04-06​

  • The properties tickets.paid.types[n].start and tickets.paid.types[n].end on the Event object may be null. For more information, check this product announcement.

2021-01-12​

  • Attribute active removed from Trainer object. To see if a trainer has an active license, use license.active

2020-03-19​

  • Support for payments (Stripe and PayPal) was added

2020-01-23​

  • Depending on the endpoint, the type property of the Event object may be an event type object or an event type ID.

2019-12-06 and before​

2019-12-06, 2019-07-01 and 2016-12-23 are old versions of the API without any detailed changelog.