API v1 Docs - Events Endpoint

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

/get

The /get endpoint is currently not public and therefore not documented. It will become available soon after the API is fixed up. Sorry for the inconvenience.

/list/month

Returns a list of events for the specified month.

Example Request Body


				{
				"guild_id": 375357265198317579,
				"DaysInMonth": 31,
				"EpochStart": 1519884000000
				}

Example Response


				{
				"count": 1,
				"events": [{
					"id": "e7gqkup5l8",
					"epochStart": 1521732600000,
					"epochEnd": 1521761400000
				}]
				}

Supported Values in Request

Key	Value Type	Info	Required
guild_id	long	The Guild ID	True
DaysInMonth	int	Days in the month	True
EpochStart	long	First unix millisecond of the month	True

Returned Values

Key	Value Type	Info
Count	int	Amount of events in month
events	List	List of events in month
events.id	String	The event's ID
events.epochStart	long	Unix start time of event
events.epochEnd	long	Unix end time of event

/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,
				"startEpoch": 1521694800000
				}

Example Response


				{
				"count": 1,
				"events": [{
					"id": "e7gqkup5l8",
					"epochStart": 1521732600000,
					"epochEnd": 1521732600000,
					"timezone": "America/Chicago",
					"summary": "Made in the dashboard!",
					"description": "This event was created using the new dashboard",
					"location": "The void",
					"color": "BLUE",
					"isParent": true,
					"recurrence": {
						"recur": false,
						"frequency": "DAILY",
						"count": -1,
						"interval": 1,
					},
					"image": "https://goo.gl/nqi64A"
				}]
				}

Supported Values in Request

Key	Value Type	Info	Required
guild_id	long	The Guild ID	True
StartEpoch	long	First unix millisecond of the date	True

Returned Values

Key	Value Type	Info
Count	int	Amount of events in month
events	List	List of events in month
events.id	String	The event's ID
events.epochStart	long	Unix start time of event
events.epochEnd	long	Unix end time of event
events.timezone	String	The Timezone of the event/calendar
events.summary	String	The summary/name of the event
events.description	String	The description of the event
events.location	String	The location the event takes place
events.color	String	The name of the event color, "NONE" if no color used
events.image	String/URL	URL of the event's image
events.isParent	Boolean	Whether or not the event is a parent. (default true)
events.recurrence.recur	Boolean	Whether or not the event is set to recur.
events.recurrence.frequency	String	The frequency of the event's recurrence.
events.recurrence.recurCount	int	The amount of times the event recurs. (-1 or 0 for infinite)
events.recurrence.interval	int	Interval at which the event recurs (compliant to the above values)

/create

Creates a new event with the specified data.

Example Request Body


				{
				"guild_id": 375357265198317579,
				"epochStart": 1521732600000,
				"epochEnd": 1521732600000,
				"summary": "My cool event!",
				"description": "Event edited via REST API",
				"location": "The nether",
				"color": "RED",
				"recurrence": {
					"recur": false,
					"frequency": "DAILY",
					"count": -1,
					"interval": 1,
				},
				"image": "https://goo.gl/nqi64A"
				}

Example Response


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

Supported Values in Request

Key	Value Type	Info	Required
guild_id	long	The Guild ID	True
epochStart	long	Unix time of event start	True
epochEnd	long	Unix time of event start	True
summary	String	The Summary/Name of the event	True
description	String	The description of event	True
location	String	Where the event takes place	True
color	String	The color of the event (1 of 12 supported colors)	True
image	String/URL	The URL to the event's image	True
recurrence.recur	Boolean	Whether or not the event should recur	True
recurrence.frequency	String	The frequency at which the event should recur	True
recurrence.count	int	How many times the event should recur (-1 or 0 for infinite)	True
recurrence.interval	int	The interval for which the event should recur (compliant to above values)	True

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,
				"id": e7gqkup5l8,
				"epochStart": 1521732600000,
				"epochEnd": 1521732600000,
				"summary": "My cool event!",
				"description": "Event edited via REST API",
				"location": "The nether",
				"color": "RED",
				"recurrence": {
					"recur": false,
					"count": -1,
					"interval": 1,
				},
				"image": "https://goo.gl/nqi64A"
				}

Example Response


				{
				"Message": "Successfully updated event!"
				}

Supported Values in Request

Key	Value Type	Info	Required
guild_id	long	The Guild ID	True
id	String	ID of the event to edit	True
epochStart	long	Unix time of event start	True
epochEnd	long	Unix time of event start	True
summary	String	The Summary/Name of the event	True
description	String	The description of event	True
location	String	Where the event takes place	True
color	String	The color of the event (1 of 12 supported colors)	True
image	String/URL	The URL to the event's image	True
recurrence.recur	Boolean	Whether or not the event should recur	True
recurrence.frequency	String	The frequency at which the event should recur	True
recurrence.count	int	How many times the event should recur (-1 or 0 for infinite)	True
recurrence.interval	int	The interval for which the event should recur (compliant to above values)	True

Returned Values

Key	Value Type	Info
Message	String	Status of update.

/delete

Deletes the specified event.

Example Request Body


				{
				"guild_id": 375357265198317579,
				"id": e7gqkup5l8
				}

Example Response


				{
				"Message": "Successfully deleted event!"
				}

Supported Values in Request

Key	Value Type	Info	Required
guild_id	long	The Guild ID	True
id	String	ID of the event to delete	True

Returned Values

Key	Value Type	Info
Message	String	Status of deletion