Event Created
The event.created
event is triggered when a new event is created in the system.
Event Properties
Property | Type | Description |
---|---|---|
id | string | Unique identifier for the event (UUID) |
name | string | Name of the event |
state | string | Current state of the event |
started_at | string | Start date and time of the event |
ended_at | string | End date and time of the event |
created_at | string | Timestamp when the event was created |
updated_at | string | Timestamp when the event was last updated |
max_attendee_capacity | integer | Maximum number of attendees allowed |
description | string | Detailed description of the event |
slug | string | URL-friendly identifier for the event |
hosting_type | string | Type of hosting for the event (“zoom”, “live_session”, or “custom”) |
hosting_id | string | Identifier for the hosting platform or location |
join_url | string | URL for attendees to join the event |
published | boolean | Indicates whether the event is published (true) or draft (false) |
tickets | array | List of ticket types available for the event |
Hosting Types
The hosting_type
property indicates the platform or method used to host the event. It can have the following values:
"zoom"
: The event is hosted using Zoom. In this case, thehosting_id
will contain the Zoom meeting ID."live_session"
: The event uses Teachify’s built-in live session feature. Thehosting_id
will be the internal identifier for the live session."custom"
: A custom hosting solution is used, such as Google Meet or any other platform. For custom hosting, thejoin_url
property will contain the link for attendees to join the event.
The hosting_type
determines how attendees will access the event and what kind of integration or preparation is needed on the organizer’s side.
Ticket Properties
Each ticket in the tickets
array contains the following properties:
Property | Type | Description |
---|---|---|
id | string | Unique identifier for the ticket (UUID) |
level | integer | Ticket level or tier |
name | string | Name of the ticket type |
quantity | integer | Number of tickets available |
currency | string | Currency code for the ticket price (default: “TWD”) |
amount | number | Price of the ticket |
created_at | string | Timestamp when the ticket was created |
updated_at | string | Timestamp when the ticket was last updated |