Creating Events

Early Access

This functionality is available under early access. Its behavior or response format may change before general availability and it may require additional configuration by the Spektrix team to access it. Contact us if you plan to use it in a production integration.

Use this endpoint to create an Event. Event Instances, including their dates, seating plans, and prices, are created separately.

Authentication

This endpoint is available only to integrations authenticated in API v3 System Owner mode. For more detail on signing requests, see Authentication.

Request

POST api/v3/events

{
  "name": "Macbeth",
  "duration": 150,
  "description": "A new production of Macbeth.",
  "wikiText": "A new production of **Macbeth**.",
  "webEventId": "macbeth-2026",
  "Attribute_Genre": "Drama"
}

Replace any Attribute_* properties with Event attributes configured in your system.

Properties

Property	Required?	Description
name	Yes	Name of the Event. It must not be empty.
duration	No	Duration in minutes. Defaults to 0 if omitted.
description	No	Plain-text Event description. Defaults to an empty value.
wikiText	No	Formatted description in Spektrix wiki-text format. Defaults to an empty value.
webEventId	No	Optional web-facing identifier. Maximum 20 characters.
Attribute_*	No*	Values for configured Event attributes. Some attributes may be required by the client's configuration.

Successful response

A successful request returns 201 Created. The response body contains the newly created Event, including its generated id.

{
  "id": "3803APLHKHLHGKTNBRTKBMRGDKVTVTVPD",
  "name": "Macbeth",
  "duration": 150,
  "description": "A new production of Macbeth.",
  "webEventId": "macbeth-2026",
  "attributes": [
    {
      "name": "Genre",
      "value": "Drama"
    }
  ]
}

The exact response may contain additional Event properties.

Store the returned id. You will need it as the eventId when creating an Event Instance through POST /api/v3/instances. See Creating Event Instances using API v3 Owner Mode.

You can retrieve the Event later using GET /api/v3/events/{id} or change it using Updating Events using API v3 Owner Mode.

Errors

Status	Meaning
400 Bad Request	The request body is missing, name is missing or empty, or webEventId exceeds 20 characters.
401 Unauthorized	The credentials do not permit use of this System Owner mode endpoint.