Skip to content

Latest commit

 

History

History
57 lines (37 loc) · 1.95 KB

File metadata and controls

57 lines (37 loc) · 1.95 KB

DiscordScheduledEvent

Discord guild scheduled event. Returned by /v1/discord/guilds/{guildId}/events endpoints. Fields below are the subset Zernio consumes — Discord may return more (e.g. creator, image hash) which we pass through verbatim.

Properties

Name Type Description Notes
id String Event snowflake ID [optional]
guildId String [optional]
channelId String Voice/stage channel ID; null for external events. [optional]
creatorId String [optional]
name String [optional]
description String [optional]
scheduledStartTime OffsetDateTime [optional]
scheduledEndTime OffsetDateTime Required for external events; optional for voice/stage. [optional]
privacyLevel PrivacyLevelEnum Always 2 (GUILD_ONLY) — Discord deprecated PUBLIC events. [optional]
status StatusEnum 1=SCHEDULED, 2=ACTIVE, 3=COMPLETED, 4=CANCELED [optional]
entityType EntityTypeEnum 1=STAGE_INSTANCE, 2=VOICE, 3=EXTERNAL [optional]
entityId String [optional]
entityMetadata DiscordScheduledEventEntityMetadata [optional]
userCount Integer Number of members who RSVP'd. Only present when withUserCount=true on list. [optional]
image String Cover image hash; build URL via cdn.discordapp.com. [optional]

Enum: PrivacyLevelEnum

Name Value
NUMBER_2 2

Enum: StatusEnum

Name Value
NUMBER_1 1
NUMBER_2 2
NUMBER_3 3
NUMBER_4 4

Enum: EntityTypeEnum

Name Value
NUMBER_1 1
NUMBER_2 2
NUMBER_3 3