Events
Bnder API documentation for Events. Read the API Overview to get started and learn more.
Create a new event
Create a new event for the guild
POST/consumer/v1/guilds/guildId /events
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
Request body
| Field | Type | Description |
|---|---|---|
| title | string | Title of the event |
| location | string | Description of the event |
| start | string | Start date and time of the event |
| end | string | End date and time of the event |
| invitees | array | Invitees of the event |
| repeat_interval_days | number | Repeat interval in days |
| repeat_until | string | Repeat until date |
| type | string | Type of the event |
Response
Status: 200 - Event created
| Field | Type | Description |
|---|---|---|
| id | string | Id of the event |
| title | string | Title of the event |
| location | string | Location of the event |
| start | string | Start date and time of the event |
| end | string | End date and time of the event |
| isFromTask | boolean | Is the event from a task deadline |
| invitees | array | Discord user ids of the invitees |
| accepted | array | Discord user ids of the accepted invitees |
| declined | array | Discord user ids of the declined invitees |
| creator | string | Discord user id of the creator |
| repeated | boolean | Is the event repeated |
| repeatEnd | string | End date of the repeat |
| repeatIntervalDays | number | Interval in days for the repeat |
| type | string | Type of the event, e.g. "event" or "task" |
| externalId | string | External id of the event, e.g. Google Calendar event id |
Get an event
Get an event by ID
GET/consumer/v1/guilds/guildId /events/eventId
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| eventId | The ID of the event |
Request body
empty
Response
Status: 200 - Event retrieved
| Field | Type | Description |
|---|---|---|
| id | string | Id of the event |
| title | string | Title of the event |
| location | string | Location of the event |
| start | string | Start date and time of the event |
| end | string | End date and time of the event |
| isFromTask | boolean | Is the event from a task deadline |
| invitees | array | Discord user ids of the invitees |
| accepted | array | Discord user ids of the accepted invitees |
| declined | array | Discord user ids of the declined invitees |
| creator | string | Discord user id of the creator |
| repeated | boolean | Is the event repeated |
| repeatEnd | string | End date of the repeat |
| repeatIntervalDays | number | Interval in days for the repeat |
| type | string | Type of the event, e.g. "event" or "task" |
| externalId | string | External id of the event, e.g. Google Calendar event id |
Update an event
Update an existing event
PUT/consumer/v1/guilds/guildId /events/eventId
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| eventId | The ID of the event |
Request body
| Field | Type | Description |
|---|---|---|
| title | string | The title of the event |
| location | string | The location of the event |
| start | string | The start date and time of the event |
| end | string | The end date and time of the event |
| invitees | array | The invitees of the event |
| accepted | boolean | The acceptance status of the event |
| repeat_interval_days | number | Repeat interval in days |
| repeat_until | string | Repeat until date |
Response
Status: 200 - Event updated
| Field | Type | Description |
|---|---|---|
| id | string | Id of the event |
| title | string | Title of the event |
| location | string | Location of the event |
| start | string | Start date and time of the event |
| end | string | End date and time of the event |
| isFromTask | boolean | Is the event from a task deadline |
| invitees | array | Discord user ids of the invitees |
| accepted | array | Discord user ids of the accepted invitees |
| declined | array | Discord user ids of the declined invitees |
| creator | string | Discord user id of the creator |
| repeated | boolean | Is the event repeated |
| repeatEnd | string | End date of the repeat |
| repeatIntervalDays | number | Interval in days for the repeat |
| type | string | Type of the event, e.g. "event" or "task" |
| externalId | string | External id of the event, e.g. Google Calendar event id |
Delete an event
Delete an existing event
DELETE/consumer/v1/guilds/guildId /events/eventId
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
| eventId | The ID of the event |
Request body
empty
Response
Status: 204 - Event deleted
empty response
Plan an event
Plan an event for the guild
POST/consumer/v1/guilds/guildId /events/plan
| Parameters | Description |
|---|---|
| guildId | The id of a discord guild |
Request body
| Field | Type | Description |
|---|---|---|
| start | string | Start date and time of the event |
| end | string | End date and time of the event |
| invitees | array | Invitees of the event |
| type | string | Filter events by type |
Response
Status: 200 - Event planned
| Field | Type | Description |
|---|---|---|
| id | string | Id of the event |
| title | string | Title of the event |
| location | string | Location of the event |
| start | string | Start date and time of the event |
| end | string | End date and time of the event |
| isFromTask | boolean | Is the event from a task deadline |
| invitees | array | Discord user ids of the invitees |
| accepted | array | Discord user ids of the accepted invitees |
| declined | array | Discord user ids of the declined invitees |
| creator | string | Discord user id of the creator |
| repeated | boolean | Is the event repeated |
| repeatEnd | string | End date of the repeat |
| repeatIntervalDays | number | Interval in days for the repeat |
| type | string | Type of the event, e.g. "event" or "task" |
| externalId | string | External id of the event, e.g. Google Calendar event id |