API v2 Docs - Events Endpoint

The events endpoint allows you to create events, get events for the date, month, or range, and edit, and delete events.



events/get

Returns the event requested.


Example Request Body

				{
				"guild_id": 375357265198317579,
				"event_id": "e7gqkup5l8",
				"calendar_number": 1
				}
				

Example Response


				{
				"event_id": "e7gqkup5l8",
				"epoch_start": 1521732600000,
				"epoch_end": 1521732600000,
				"summary": "Weekly study group",
				"description": "Time to study!",
				"location": "Building A, Room 205",
				"is_parent": false,
				"color": "NONE",
				"recur": true,
				"recurrence": {
					"frequency": "WEEKLY",
					"count": -1,
					"interval": 1
					},
				"image": "https://imgur.com/totallyARealLink.png"
				}
				

Supported Values in Request
Key Value Type Info Required
guild_id string The Guild ID True
event_id String The ID of the event to get True
calendar_number int The calendar number to get the event from, "1" for main calendar True

Returned Values
Key Value Type Info
event_id String The ID of the event
epoch_start long The time the event starts at
epoch_end long The time the event ends at
summary String The summary/name of the event. *May not always be included*
description String The long description of the event. *May not always be included*
location String Where the event is held *May not always be included*
is_parent Boolean Whether or not this event is a parent of other events *Only applicable if "recur" is true*
color String, enum name of Color enum The color of the event, "NONE" if no color is set
recur Boolean Whether or not this event is a recurring event
recurrence JSON Object The recurrence settings of this event *Only present if "recur" is true*
recurrence.frequency String, enum name of Frequency enum The frequency of the event.
recurrence.count int How many times this event recurs, "-1" for infinite
recurrence.interval int The skip interval for the event
image String, link The link to the event's image *May not always be included*


events/list/month

Returns a list of events for the specified month.


Example Request Body

				{
				"guild_id": 375357265198317579,
				"calendar_number": 1,
				"days_in_month": 31,
				"epoch_start": 1519884000000
				}
				

Example Response


				{
				"events": [{
					"event_id": "e7gqkup5l8",
					"epoch_start": 1521732600000,
					"epoch_end": 1521732600000,
					"summary": "Weekly study group",
					"description": "Time to study!",
					"location": "Building A, Room 205",
					"is_parent": false,
					"color": "NONE",
					"recur": true,
					"recurrence": {
						"frequency": "WEEKLY",
						"count": -1,
						"interval": 1
					},
					"image": "https://imgur.com/totallyARealLink.png"
				}]
				}
				

Supported Values in Request
Key Value Type Info Required
guild_id string The Guild ID True
days_in_month int Days in the month True
epoch_start long First unix millisecond of the month True
calendar_number int The number of the calendar to use. *"1" for the main calendar* True

Returned Values
Key Value Type Info
events List List of events in month
events.event_id String The ID of the event
events.epoch_start long The time the event starts at
events.epoch_end long The time the event ends at
events.summary String The summary/name of the event. *May not always be included*
events.description String The long description of the event. *May not always be included*
events.location String Where the event is held *May not always be included*
events.is_parent Boolean Whether or not this event is a parent of other events *Only applicable if "recur" is true*
events.color String, enum name of Color enum The color of the event, "NONE" if no color is set
events.recur Boolean Whether or not this event is a recurring event
events.recurrence JSON Object The recurrence settings of this event *Only present if "recur" is true*
events.recurrence.frequency String, enum name of Frequency enum The frequency of the event.
events.recurrence.count int How many times this event recurs, "-1" for infinite
events.recurrence.interval int The skip interval for the event
events.image String, link The link to the event's image *May not always be included*


events/list/date

Returns a list of events for the specified date. Automatically adds 24 hours to the start time.


Example Request Body

				{
				"guild_id": 375357265198317579,
				"calendar_number": 1,
				"epoch_start": 1521694800000
				}
				

Example Response


				{
				"events": [{
					"event_id": "e7gqkup5l8",
					"epoch_start": 1521732600000,
					"epoch_end": 1521732600000,
					"summary": "Weekly study group",
					"description": "Time to study!",
					"location": "Building A, Room 205",
					"is_parent": false,
					"color": "NONE",
					"recur": true,
					"recurrence": {
						"frequency": "WEEKLY",
						"count": -1,
						"interval": 1
					},
					"image": "https://imgur.com/totallyARealLink.png"
				}]
				}
				

Supported Values in Request
Key Value Type Info Required
guild_id string The Guild ID True
calendar_number int The number of the calendar to use, *1 for the main calendar* True
epoch_start long First unix millisecond of the date True

Returned Values
Key Value Type Info
events List List of events in month
events.event_id String The ID of the event
events.epoch_start long The time the event starts at
events.epoch_end long The time the event ends at
events.summary String The summary/name of the event. *May not always be included*
events.description String The long description of the event. *May not always be included*
events.location String Where the event is held *May not always be included*
events.is_parent Boolean Whether or not this event is a parent of other events *Only applicable if "recur" is true*
events.color String, enum name of Color enum The color of the event, "NONE" if no color is set
events.recur Boolean Whether or not this event is a recurring event
events.recurrence JSON Object The recurrence settings of this event *Only present if "recur" is true*
events.recurrence.frequency String, enum name of Frequency enum The frequency of the event.
events.recurrence.count int How many times this event recurs, "-1" for infinite
events.recurrence.interval int The skip interval for the event
events.image String, link The link to the event's image *May not always be included*


events/list/range

Returns a list of events for the specified range.


Example Request Body

				{
				"guild_id": 375357265198317579,
				"calendar_number": 1,
				"epoch_start": 1521694800000,
				"epoch_end": 1521744800000,
				}
				

Example Response


				{
				"events": [{
					"event_id": "e7gqkup5l8",
					"epoch_start": 1521732600000,
					"epoch_end": 1521732600000,
					"summary": "Weekly study group",
					"description": "Time to study!",
					"location": "Building A, Room 205",
					"is_parent": false,
					"color": "NONE",
					"recur": true,
					"recurrence": {
						"frequency": "WEEKLY",
						"count": -1,
						"interval": 1
					},
					"image": "https://imgur.com/totallyARealLink.png"
				}]
				}
				

Supported Values in Request
Key Value Type Info Required
guild_id string The Guild ID True
calendar_number int The number of the calendar to use, *1 for the main calendar* True
epoch_start long First unix millisecond of the range True
epoch_end long Last unix millisecond of the range True

Returned Values
Key Value Type Info
events List List of events in month
events.event_id String The ID of the event
events.epoch_start long The time the event starts at
events.epoch_end long The time the event ends at
events.summary String The summary/name of the event. *May not always be included*
events.description String The long description of the event. *May not always be included*
events.location String Where the event is held *May not always be included*
events.is_parent Boolean Whether or not this event is a parent of other events *Only applicable if "recur" is true*
events.color String, enum name of Color enum The color of the event, "NONE" if no color is set
events.recur Boolean Whether or not this event is a recurring event
events.recurrence JSON Object The recurrence settings of this event *Only present if "recur" is true*
events.recurrence.frequency String, enum name of Frequency enum The frequency of the event.
events.recurrence.count int How many times this event recurs, "-1" for infinite
events.recurrence.interval int The skip interval for the event
events.image String, link The link to the event's image *May not always be included*


/create

Creates a new event with the specified data.


Example Request Body

				{
				"guild_id": 375357265198317579,
				"calendar_number": 1,
				"event_id": "e7gqkup5l8",
				"epoch_start": 1521732600000,
				"epoch_end": 1521732600000,
				"summary": "Weekly study group",
				"description": "Time to study!",
				"location": "Building A, Room 205",
				"is_parent": false,
				"color": "NONE",
				"recur": true,
				"recurrence": {
					"frequency": "WEEKLY",
					"count": -1,
					"interval": 1
				},
				"image": "https://imgur.com/totallyARealLink.png"
				}
				

Example Response


				{
				"message": "Successfully created event!",
				"id": "e7gqkup5l8"
				}
				

Supported Values in Request
Key Value Type Info
guild_id string The Guild ID True
calendar_number int The number of the calendar to use, *1 for the main calendar* True
epoch_start long The time the event starts at
epoch_end long The time the event ends at
summary String The summary/name of the event. *Optional*
description String The long description of the event. *Optional*
location String Where the event is held *Optional*
color String, enum name of Color enum The color of the event, "NONE" if no color is set *Optional*
recur Boolean Whether or not this event is a recurring event *Optional, only required if recurrence exists*
events.recurrence JSON Object The recurrence settings of this event *Only present if "recur" is true*
recurrence.frequency String, enum name of Frequency enum The frequency of the event.
recurrence.count int How many times this event recurs, "-1" for infinite
recurrence.interval int The skip interval for the event
image String, link The link to the event's image *Optional*

Returned Values
Key Value Type Info
message String Status of creation
id String ID of the event created


/update

Updates the specified event with the provided data.


Example Request Body

				{
				"guild_id": 375357265198317579,
				"calendar_number": 1,
				"event_id": "e7gqkup5l8",
				"epoch_end": 1521732600000,
				"summary": "Weekly study group",
				"location": "Building A, Room 205",
				"is_parent": false,
				"color": "RED",
				}
				

Example Response


				{
				"message": "Event updated successfully!"
				}
				

Supported Values in Request
Key Value Type Info Required
guild_id string The Guild ID True
calendar_number int The number of the calendar to use, *1 for the main calendar* True
event_id String ID of the event to edit True
epoch_start long The time the event starts at
epoch_end long The time the event ends at
summary String The summary/name of the event. *Optional*
description String The long description of the event. *Optional*
location String Where the event is held *Optional*
color String, enum name of Color enum The color of the event, "NONE" if no color is set *Optional*
recur Boolean Whether or not this event is a recurring event *Optional, only required if recurrence exists*
events.recurrence JSON Object The recurrence settings of this event *Only present if "recur" is true*
recurrence.frequency String, enum name of Frequency enum The frequency of the event.
recurrence.count int How many times this event recurs, "-1" for infinite
recurrence.interval int The skip interval for the event
image String, link The link to the event's image *Optional*

Returned Values
Key Value Type Info
message String Status of update.


/delete

Deletes the specified event.


Example Request Body

				{
				"guild_id": 375357265198317579,
				"calendar_number": 1,
				"event_id": "e7gqkup5l8",
				}
				

Example Response


				{
				"message": "Event successfully deleted!"
				}
				

Supported Values in Request
Key Value Type Info Required
guild_id string The Guild ID True
calendar_number int The number of the calendar to use, *1 for main calendar* True
event_id String ID of the event to delete True

Returned Values
Key Value Type Info
message String Status of deletion