Event Properties Reference

This page provides detailed information about the properties and nested objects used in the Events API.

Event Occurrence

Event occurrences represent specific dates and times when an event takes place. An event can have multiple occurrences.

Properties

Property	Type	Required	Description
id	string (uuid)	No (auto-generated)	The unique identifier of the occurrence
startDate	string (ISO 8601)	Yes	The start date and time of the event occurrence
endDate	string (ISO 8601)	No	The end date and time of the event occurrence
capacity	number	Yes	The maximum capacity of the event occurrence (minimum: 0)

Example

{
  "id": "789e0123-e89b-12d3-a456-426614174006",
  "startDate": "2025-12-25T10:00:00.000Z",
  "endDate": "2025-12-25T18:00:00.000Z",
  "capacity": 100
}

Event Publishing Channel

Publishing channels define where and when an event is published.

Properties

Property	Type	Required	Description
id	string (uuid)	No (auto-generated)	The unique identifier of the publishing channel
name	string	Yes	The name of the publishing channel
channelType	string	Yes	The type of channel (e.g., WIDGET, SLACK, EMAIL)
externalId	string	No	External identifier for the channel
publishDate	string (ISO 8601)	No	The date and time when the event should be published

Example

{
  "id": "890e1234-e89b-12d3-a456-426614174007",
  "name": "Main Widget",
  "channelType": "WIDGET",
  "externalId": "ext-123",
  "publishDate": "2025-12-25T10:00:00.000Z"
}

Event Notification

Notifications define automated reminders or alerts sent to attendees.

Properties

Property	Type	Required	Description
id	string (uuid)	No (auto-generated)	The unique identifier of the notification
timing	string	Yes	When to send the notification: BEFORE or AFTER
timeUnit	string	Yes	The time unit: MINUTES, HOURS, DAYS, or WEEKS
timeValue	number	Yes	The time value (e.g., 30 for "30 minutes before")
channel	string	Yes	The notification channel: EMAIL, SMS, or PUSH
notificationType	string	Yes	The type of notification: EVENT_REMINDER, EVENT_CONFIRMATION, etc.

Example

{
  "id": "901e2345-e89b-12d3-a456-426614174008",
  "timing": "BEFORE",
  "timeUnit": "MINUTES",
  "timeValue": 30,
  "channel": "EMAIL",
  "notificationType": "EVENT_REMINDER"
}

Event Category

Categories help organize and filter events.

Properties

Property	Type	Description
id	string (uuid)	The unique identifier of the category
name	string	The name of the category
slug	string	The URL-friendly identifier for the category
description	string	The description of the category

Example

{
  "id": "123e4567-e89b-12d3-a456-426614174004",
  "name": "Technology",
  "slug": "technology",
  "description": "Technology-related events"
}

Complete Event Example

Here's a complete example of an event with all nested objects:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Annual Tech Conference 2025",
  "slug": "annual-tech-conference-2025",
  "description": "Join us for the biggest tech conference of the year featuring keynote speakers, workshops, and networking opportunities.",
  "image": "https://example.com/images/conference-2025.jpg",
  "extraFields": {
    "title": "Conference 2025",
    "subtitle": "Innovation and Technology",
    "venue": "Convention Center"
  },
  "occurrences": [
    {
      "id": "789e0123-e89b-12d3-a456-426614174006",
      "startDate": "2025-12-25T09:00:00.000Z",
      "endDate": "2025-12-25T18:00:00.000Z",
      "capacity": 500
    },
    {
      "id": "789e0124-e89b-12d3-a456-426614174007",
      "startDate": "2025-12-26T09:00:00.000Z",
      "endDate": "2025-12-26T18:00:00.000Z",
      "capacity": 500
    }
  ],
  "categories": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174004",
      "name": "Technology",
      "slug": "technology"
    },
    {
      "id": "456e7890-e89b-12d3-a456-426614174005",
      "name": "Conference",
      "slug": "conference"
    }
  ],
  "template": {
    "id": "456e7890-e89b-12d3-a456-426614174001",
    "name": "Conference Template",
    "slug": "conference-template"
  },
  "eventPublishingChannels": [
    {
      "id": "890e1234-e89b-12d3-a456-426614174007",
      "name": "Main Widget",
      "channelType": "WIDGET",
      "externalId": "widget-main",
      "publishDate": "2025-12-01T00:00:00.000Z"
    },
    {
      "id": "890e1235-e89b-12d3-a456-426614174008",
      "name": "Newsletter",
      "channelType": "EMAIL",
      "publishDate": "2025-12-01T08:00:00.000Z"
    }
  ],
  "notifications": [
    {
      "id": "901e2345-e89b-12d3-a456-426614174008",
      "timing": "BEFORE",
      "timeUnit": "DAYS",
      "timeValue": 1,
      "channel": "EMAIL",
      "notificationType": "EVENT_REMINDER"
    },
    {
      "id": "901e2346-e89b-12d3-a456-426614174009",
      "timing": "BEFORE",
      "timeUnit": "HOURS",
      "timeValue": 2,
      "channel": "SMS",
      "notificationType": "EVENT_REMINDER"
    }
  ],
  "createdAt": "2025-10-12T10:30:00.000Z",
  "updatedAt": "2025-10-15T14:20:00.000Z"
}

Notes

• When updating events, nested objects (occurrences, publishingChannels, notifications) follow a specific pattern:
  • Without id: Creates a new item
  • With id: Updates existing item
  • Existing items not included in the update: Will be deleted
• All date/time fields use ISO 8601 format in UTC timezone
• The extraFields object can contain any custom data in JSON format
• Category associations are managed through the categoryIds array in create/update operations