Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Emitted when a bot is added to a server
Created by
The ID of the user who created this server membership
Emitted when a bot is removed from a server
Deleted by
The ID of the user who deleted this server membership
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Optional
calendarCalendar event ID
The calendar event deletions started at
Server ID
The ID of the server
Optional
calendarCalendar event ID
The calendar event updates started at
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Deleted by
The ID of the user who deleted this reaction
Server ID
The ID of the server
Channel ID Format: uuid
The ID of the channel
The count of reactions that were removed
Deleted by
The ID of the user who deleted this reaction
Optional
emote?: components["schemas"]["Emote"]If present, only reactions of this emote were bulk removed from the message
Message ID Format: uuid
The ID of the message
Server ID
The ID of the server
Server ID
The ID of the server
Channel ID Format: uuid
The ID of the channel
Deleted at Format: date-time
The ISO 8601 timestamp that the message was deleted at
Message ID Format: uuid
The ID of the message
Optional
isIs private
Optional
serverServer ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Optional
isIs ban?
If this member leaving was the result of a ban
Optional
isIs kick?
If this member leaving was the result of a kick
Server ID
The ID of the server
User ID
The ID of the user
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
User ID
The ID of the user
Optional
nickname?: string | nullNickname
The nickname that was just updated for the user
Server ID
The ID of the server
Server ID
The ID of the server
Server ID
The ID of the server
Bot ID Format: uuid
The ID of the bot
The interval in milliseconds that your bot should be configured to send ping frames for the bot's heartbeat to be considered valid.
The last message's ID that was sent to this bot. See event replay for more details
{
* "id": "9RVMoDZy",
* "serverId": "wlVr3Ggl",
* "channelId": "00000000-0000-0000-0000-000000000000",
* "createdAt": "2021-06-15T20:15:00.706Z",
* "createdBy": "Ann6LewA",
* "title": "Pizza Party, don't be tardy!",
* "content": "Grab a slice, don't be slow, At our pizza party, it's the way to go! Toppings galore, cheesy delight, Come join us, it'll be out of sight!"
* }
Channel ID Format: uuid
The ID of the channel
Content Format: markdown
The content of the announcement
Created at Format: date-time
The ISO 8601 timestamp that the announcement was created at
Created by
The ID of the user who created this announcement
Announcement ID
The ID of the announcement
Optional
mentions?: components["schemas"]["Mentions"]Server ID
The ID of the server
Title
The title of the announcement
{
* "id": 123456,
* "content": "Now THAT is one awesome announcement!!!",
* "createdAt": "2023-04-07T16:19:00.000Z",
* "channelId": "00000000-0000-0000-0000-000000000000",
* "announcementId": "9RVMoDZy",
* "createdBy": "Ann6LewA"
* }
Announcement ID
The ID of the announcement
Channel ID Format: uuid
The ID of the channel
Content Format: markdown
The content of the announcement comment
Created at Format: date-time
The ISO 8601 timestamp that the announcement comment was created at
Created by
The ID of the user who created this announcement comment (Note: If this event has createdByWebhookId
present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)
Announcement comment ID
The ID of the announcement comment
Optional
mentions?: components["schemas"]["Mentions"]Optional
updatedUpdated at Format: date-time
The ISO 8601 timestamp that the announcement comment was updated at, if relevant
{
* "channelId": "00000000-0000-0000-0000-000000000000",
* "createdBy": "Ann6LewA",
* "emote": {
* "id": 90000000,
* "name": "grinning",
* "url": "https://img.guildedcdn.com/asset/Emojis/grinning.webp"
* },
* "announcementId": "9RVMoDZy",
* "announcementCommentId": 123456
* }
Announcement comment ID
The ID of the announcement comment
Announcement ID
The ID of the announcement
Channel ID Format: uuid
The ID of the channel
User ID
The ID of the user who added the reaction
{
* "channelId": "00000000-0000-0000-0000-000000000000",
* "createdBy": "Ann6LewA",
* "emote": {
* "id": 90000000,
* "name": "grinning",
* "url": "https://img.guildedcdn.com/asset/Emojis/grinning.webp"
* },
* "announcementId": "9RVMoDZy"
* }
Announcement ID
The ID of the announcement
Channel ID Format: uuid
The ID of the channel
User ID
The ID of the user who added the reaction
{
* "id": 1,
* "serverId": "wlVr3Ggl",
* "channelId": "00000000-0000-0000-0000-000000000000",
* "name": "Surprise LAN party for my wife 🤫",
* "description": "**Don't say anything to her!** She's gonna love playing Call of Duty all night",
* "location": "My house!",
* "url": "https://www.surprisepartygame.com/",
* "duration": 60,
* "color": 16106496,
* "startsAt": "2022-06-16T00:00:00.000Z",
* "createdAt": "2021-06-15T20:15:00.706Z",
* "createdBy": "Ann6LewA"
* }
Optional
autofillWhen rsvpLimit
is set, users from the waitlist will be added as space becomes available in the event
Optional
cancellation?: { Created by
The ID of the user who created this event cancellation
Optional
description?: stringDescription Format: markdown
The description of event cancellation
Channel ID Format: uuid
The ID of the channel
Optional
color?: numberThe color of the event when viewing in the calendar
Created at Format: date-time
The ISO 8601 timestamp that the event was created at
Created by
The ID of the user who created this event
Optional
description?: stringDescription Format: markdown
The description of the event
Optional
duration?: numberDuration
The duration of the event in minutes
Calendar event ID
The ID of the calendar event
Optional
isIs all day
Does the event last all day
Optional
isIs private
Optional
location?: stringLocation
The location of the event
Optional
mentions?: components["schemas"]["Mentions"]Name
The name of the event
Optional
repeats?: booleanIs this event a repeating event
Optional
roleRole IDs
The role IDs to restrict the event to
Optional
rsvpRSVP disabled
When disabled, users will not be able to RSVP to the event
Optional
rsvpThe number of RSVPs to allow before waitlisting RSVPs
Optional
seriesCalendar event series ID Format: uuid
The ID of the calendar event series. Only shows if the event is repeating
Server ID
The ID of the server
Starts at Format: date-time
The ISO 8601 timestamp that the event starts at
Optional
url?: stringFormat: uri
A URL to associate with the event
{
* "id": 1234567890,
* "content": "I will be there!!",
* "channelId": "00000000-0000-0000-0000-000000000000",
* "createdAt": "2022-06-15T20:15:00.706Z",
* "createdBy": "Ann6LewA",
* "calendarEventId": 987654321
* }
Calendar event ID
The ID of the calendar event
Channel ID Format: uuid
The ID of the channel
Content Format: markdown
The content of the calendar event comment
Created at Format: date-time
The ISO 8601 timestamp that the calendar event comment was created at
Created by
The ID of the user who created this calendar event comment (Note: If this event has createdByWebhookId
present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)
Calendar event comment ID
The ID of the calendar event comment
Optional
mentions?: components["schemas"]["Mentions"]Optional
updatedUpdated at Format: date-time
The ISO 8601 timestamp that the calendar event comment was updated at, if relevant
{
* "channelId": "00000000-0000-0000-0000-000000000000",
* "createdBy": "Ann6LewA",
* "emote": {
* "id": 90000000,
* "name": "grinning",
* "url": "https://img.guildedcdn.com/asset/Emojis/grinning.webp"
* },
* "calendarEventId": 1,
* "calendarEventCommentId": 1234567890
* }
Calendar event comment ID
The ID of the calendar event comment
Calendar event ID
The ID of the calendar event
Channel ID Format: uuid
The ID of the channel
User ID
The ID of the user who added the reaction
{
* "channelId": "00000000-0000-0000-0000-000000000000",
* "createdBy": "Ann6LewA",
* "emote": {
* "id": 90000000,
* "name": "grinning",
* "url": "https://img.guildedcdn.com/asset/Emojis/grinning.webp"
* },
* "calendarEventId": 1
* }
Calendar event ID
The ID of the calendar event
Channel ID Format: uuid
The ID of the channel
User ID
The ID of the user who added the reaction
{
* "calendarEventId": 1,
* "channelId": "00000000-0000-0000-0000-000000000000",
* "serverId": "wlVr3Ggl",
* "userId": "Ann6LewA",
* "status": "going",
* "createdAt": "2021-06-15T20:15:00.706Z",
* "createdBy": "Ann6LewA"
* }
Calendar event ID
The ID of the calendar event
Channel ID Format: uuid
The ID of the channel
Created at Format: date-time
The ISO 8601 timestamp that the RSVP was created at
Created by
The ID of the user who created this RSVP
Server ID
The ID of the server
Status
The status of the RSVP
Optional
updatedUpdated at Format: date-time
The ISO 8601 timestamp that the RSVP was updated at, if relevant
Optional
updatedUpdated by
The ID of the user who updated this RSVP
User ID
The ID of the user
{
* "id": "00000000-0000-0000-0000-000000000000",
* "serverId": "wlVr3Ggl",
* "channelId": "00000000-0000-0000-0000-000000000000"
* }
Channel ID Format: uuid
The ID of the channel
Calendar event series ID Format: uuid
The ID of the calendar event series
Server ID
The ID of the server
Rich content sections optionally associated with chat messages. Properties with "webhook-markdown" support allow for the following: link, italic, bold, strikethrough, underline, inline code, block code, reaction, and mention.
{
* "title": "embed title",
* "description": "embeds support a **different** __subset__ *of* markdown than other markdown fields. <@Ann6LewA>\n\n [links](https://www.guilded.gg) ```\ncheck this code out```\n\n:pizza: time!! ttyl",
* "url": "https://www.guilded.gg",
* "color": 6118369,
* "timestamp": "2022-04-12T22:14:36.737Z",
* "footer": {
* "icon_url": "https://www.guilded.gg/asset/Logos/logomark/Color/Guilded_Logomark_Color.png",
* "text": "footer text"
* },
* "thumbnail": {
* "url": "https://www.guilded.gg/asset/Logos/logomark/Color/Guilded_Logomark_Color.png"
* },
* "image": {
* "url": "https://www.guilded.gg/asset/Logos/logomark_wordmark/Color/Guilded_Logomark_Wordmark_Color.png"
* },
* "author": {
* "name": "Gil",
* "url": "https://www.guilded.gg",
* "icon_url": "https://www.guilded.gg/asset/Default/Gil-md.png"
* },
* "fields": [
* {
* "name": "hello",
* "value": "these are fields"
* },
* {
* "name": "~~help i have been crossed out~~",
* "value": "~~oh noes~~",
* "inline": true
* },
* {
* "name": "another inline",
* "value": "field",
* "inline": true
* }
* ]
* }
Optional
author?: { A small section above the title of the embed
Optional
icon_Format: media-uri
URL of a small image to display to the left of the author's name
Optional
name?: stringName of the author
Optional
url?: stringFormat: uri
URL to linkify the author's name
field
Optional
color?: numberDecimal value of the color that the left border should be
Optional
description?: stringFormat: webhook-markdown
Subtext of the embed
Optional
fields?: { Table-like cells to add to the embed
Optional
footer?: { A small section at the bottom of the embed
Optional
icon_Format: media-uri
URL of a small image to put in the footer
Text of the footer
Optional
image?: { The main picture to associate with the embed
Optional
url?: stringFormat: media-uri
URL of the image
Optional
thumbnail?: { An image to the right of the embed's content
Optional
url?: stringFormat: media-uri
URL of the image
Optional
timestamp?: stringFormat: date-time
A timestamp to put in the footer
Optional
title?: stringFormat: webhook-markdown
Main header of the embed
Optional
url?: stringFormat: uri
URL to linkify the title
field with
{
* "id": "00000000-0000-0000-0000-000000000000",
* "type": "default",
* "serverId": "wlVr3Ggl",
* "groupId": "ZVzBo83p",
* "channelId": "00000000-0000-0000-0000-000000000000",
* "content": "Hello **world**!",
* "embeds": [
* {
* "title": "embed title",
* "description": "embeds support a **different** __subset__ *of* markdown than other markdown fields. <@Ann6LewA>\n\n [links](https://www.guilded.gg) ```\ncheck this code out```\n\n:pizza: time!! ttyl",
* "url": "https://www.guilded.gg",
* "color": 6118369,
* "timestamp": "2022-04-12T22:14:36.737Z",
* "footer": {
* "icon_url": "https://www.guilded.gg/asset/Logos/logomark/Color/Guilded_Logomark_Color.png",
* "text": "footer text"
* },
* "thumbnail": {
* "url": "https://www.guilded.gg/asset/Logos/logomark/Color/Guilded_Logomark_Color.png"
* },
* "image": {
* "url": "https://www.guilded.gg/asset/Logos/logomark_wordmark/Color/Guilded_Logomark_Wordmark_Color.png"
* },
* "author": {
* "name": "Gil",
* "url": "https://www.guilded.gg",
* "icon_url": "https://www.guilded.gg/asset/Default/Gil-md.png"
* },
* "fields": [
* {
* "name": "hello",
* "value": "these are fields"
* },
* {
* "name": "~~help i have been crossed out~~",
* "value": "~~oh noes~~",
* "inline": true
* },
* {
* "name": "another inline",
* "value": "field",
* "inline": true
* }
* ]
* }
* ],
* "createdAt": "2021-06-15T20:15:00.706Z",
* "createdBy": "Ann6LewA"
* }
Channel ID Format: uuid
The ID of the channel
Optional
content?: stringContent Format: markdown
The content of the message
Created at Format: date-time
The ISO 8601 timestamp that the message was created at
Created by
The ID of the user who created this message (Note: If this event has createdByWebhookId
present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)
Optional
createdCreated by Webhook ID
The ID of the webhook who created this message, if it was created by a webhook
Optional
embeds?: components["schemas"]["ChatEmbed"][]Optional
groupGroup ID
The ID of the group
Message ID Format: uuid
The ID of the message
Optional
isIs private
If set, this message will only be seen by those mentioned or replied to
Optional
isIs silent
If set, this message did not notify mention or reply recipients
false
Optional
mentions?: components["schemas"]["Mentions"]Optional
replyMessage IDs that were replied to
Optional
serverServer ID
The ID of the server
Type
The type of chat message. "system" messages are generated by Guilded, while "default" messages are user or bot-generated.
Optional
updatedUpdated at Format: date-time
The ISO 8601 timestamp that the message was updated at, if relevant
{
* "channelId": "00000000-0000-0000-0000-000000000000",
* "createdBy": "Ann6LewA",
* "emote": {
* "id": 90000000,
* "name": "grinning",
* "url": "https://img.guildedcdn.com/asset/Emojis/grinning.webp"
* },
* "messageId": "00000000-0000-0000-0000-000000000000"
* }
Channel ID Format: uuid
The ID of the channel
User ID
The ID of the user who added the reaction
Message ID Format: uuid
The ID of the message
{
* "id": 0,
* "serverId": "wlVr3Ggl",
* "channelId": "00000000-0000-0000-0000-000000000000",
* "title": "HOW-TO: Smoke These Meats with Sweet Baby Ray's",
* "content": "Spicy jalapeno bacon ipsum dolor amet sirloin ground round short loin, meatball brisket capicola tri-tip ham pork belly biltong corned beef chuck. Chicken ham brisket shank rump buffalo t-bone. Short loin sausage buffalo porchetta pork belly rump tri-tip frankfurter tail pork chop cow sirloin. Pancetta porchetta tail ball tip chislic beef ribs. Buffalo andouille leberkas jerky. Fatback shankle andouille beef. Cow kielbasa buffalo pork loin chislic meatloaf short loin rump meatball prosciutto.",
* "createdAt": "2021-06-15T20:15:00.706Z",
* "createdBy": "Ann6LewA",
* "updatedAt": "2021-07-15T22:20:00.706Z",
* "updatedBy": "Ann6LewA"
* }
Channel ID Format: uuid
The ID of the channel
Content Format: markdown
The content of the doc
Created at Format: date-time
The ISO 8601 timestamp that the doc was created at
Created by
The ID of the user who created this doc
Doc ID
The ID of the doc
Optional
mentions?: components["schemas"]["Mentions"]Server ID
The ID of the server
Title
The title of the doc
Optional
updatedUpdated at Format: date-time
The ISO 8601 timestamp that the doc was updated at, if relevant
Optional
updatedUpdated by
The ID of the user who updated this doc
{
* "id": 123456,
* "content": "Wow, cool document!!!",
* "createdAt": "2021-06-15T20:15:00.706Z",
* "channelId": "00000000-0000-0000-0000-000000000000",
* "docId": 0,
* "createdBy": "Ann6LewA"
* }
Channel ID Format: uuid
The ID of the channel
Content Format: markdown
The content of the doc comment
Created at Format: date-time
The ISO 8601 timestamp that the doc comment was created at
Created by
The ID of the user who created this doc comment (Note: If this event has createdByWebhookId
present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)
Doc ID
The ID of the doc
Doc comment ID
The ID of the doc comment
Optional
mentions?: components["schemas"]["Mentions"]Optional
updatedUpdated at Format: date-time
The ISO 8601 timestamp that the doc comment was updated at, if relevant
{
* "channelId": "00000000-0000-0000-0000-000000000000",
* "createdBy": "Ann6LewA",
* "emote": {
* "id": 90000000,
* "name": "grinning",
* "url": "https://img.guildedcdn.com/asset/Emojis/grinning.webp"
* },
* "docId": 0,
* "docCommentId": 123456
* }
Channel ID Format: uuid
The ID of the channel
User ID
The ID of the user who added the reaction
Doc comment ID
The ID of the doc comment
Doc ID
The ID of the doc
{
* "channelId": "00000000-0000-0000-0000-000000000000",
* "createdBy": "Ann6LewA",
* "emote": {
* "id": 90000000,
* "name": "grinning",
* "url": "https://img.guildedcdn.com/asset/Emojis/grinning.webp"
* },
* "docId": 0
* }
Channel ID Format: uuid
The ID of the channel
User ID
The ID of the user who added the reaction
Doc ID
The ID of the doc
{
* "id": 90000000,
* "name": "grinning",
* "url": "https://img.guildedcdn.com/asset/Emojis/grinning.webp"
* }
Emote ID
The ID of the emote
Name
The name of the emote
Optional
serverServer ID
The ID of the server the emote was created on
Emote URL Format: media-uri
The URL of the emote image
{
* "id": 123456,
* "serverId": "wlVr3Ggl",
* "channelId": "00000000-0000-0000-0000-000000000000",
* "title": "Welcome new members!!",
* "createdAt": "2021-06-15T20:15:00.706Z",
* "createdBy": "Ann6LewA",
* "content": "Please introduce yourself in this topic!!!"
* }
Optional
bumpedBumped at Format: date-time
The ISO 8601 timestamp that the forum topic was bumped at. This timestamp is updated whenever there is any activity on the posts within the forum topic.
Channel ID Format: uuid
The ID of the channel
Content Format: markdown
The content of the forum topic
Created at Format: date-time
The ISO 8601 timestamp that the forum topic was created at
Created by
The ID of the user who created this forum topic (Note: If this event has createdByWebhookId
present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)
The ID of the forum topic
Optional
isIs locked
false
Optional
isIs pinned
false
Optional
mentions?: components["schemas"]["Mentions"]Server ID
The ID of the server
Title
The title of the forum topic
Optional
updatedUpdated at Format: date-time
The ISO 8601 timestamp that the forum topic was updated at, if relevant
{
* "id": 1234567890,
* "content": "Great idea!",
* "createdAt": "2021-06-15T20:15:00.706Z",
* "channelId": "00000000-0000-0000-0000-000000000000",
* "forumTopicId": 2036274747,
* "createdBy": "Ann6LewA"
* }
Channel ID Format: uuid
The ID of the channel
Content Format: markdown
The content of the forum topic comment
Created at Format: date-time
The ISO 8601 timestamp that the forum topic comment was created at
Created by
The ID of the user who created this forum topic comment (Note: If this event has createdByWebhookId
present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)
The ID of the forum topic
The ID of the forum topic comment
Optional
mentions?: components["schemas"]["Mentions"]Optional
updatedUpdated at Format: date-time
The ISO 8601 timestamp that the forum topic comment was updated at, if relevant
{
* "channelId": "00000000-0000-0000-0000-000000000000",
* "createdBy": "Ann6LewA",
* "emote": {
* "id": 90000000,
* "name": "grinning",
* "url": "https://img.guildedcdn.com/asset/Emojis/grinning.webp"
* },
* "forumTopicId": 123456,
* "forumTopicCommentId": 1234567890
* }
Channel ID Format: uuid
The ID of the channel
User ID
The ID of the user who added the reaction
The ID of the forum topic comment
The ID of the forum topic
{
* "channelId": "00000000-0000-0000-0000-000000000000",
* "createdBy": "Ann6LewA",
* "emote": {
* "id": 90000000,
* "name": "grinning",
* "url": "https://img.guildedcdn.com/asset/Emojis/grinning.webp"
* },
* "forumTopicId": 123456
* }
Channel ID Format: uuid
The ID of the channel
User ID
The ID of the user who added the reaction
The ID of the forum topic
{
* "id": 123456,
* "serverId": "wlVr3Ggl",
* "channelId": "00000000-0000-0000-0000-000000000000",
* "title": "Welcome new members!!",
* "createdAt": "2021-06-15T20:15:00.706Z",
* "createdBy": "Ann6LewA"
* }
Optional
bumpedBumped at Format: date-time
The ISO 8601 timestamp that the forum topic was bumped at. This timestamp is updated whenever there is any activity on the posts within the forum topic.
Channel ID Format: uuid
The ID of the channel
Created at Format: date-time
The ISO 8601 timestamp that the forum topic was created at
Created by
The ID of the user who created this forum topic (Note: If this event has createdByWebhookId
present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)
The ID of the forum topic
Optional
isIs locked
false
Optional
isIs pinned
false
Server ID
The ID of the server
Title
The title of the forum topic
Optional
updatedUpdated at Format: date-time
The ISO 8601 timestamp that the forum topic was updated at, if relevant
{
* "id": "00000000-0000-0000-0000-000000000000",
* "serverId": "wlVr3Ggl",
* "channelId": "00000000-0000-0000-0000-000000000000",
* "message": "Remember to say hello **world**!",
* "createdAt": "2021-06-15T20:15:00.706Z",
* "createdBy": "Ann6LewA",
* "note": {
* "createdAt": "2021-06-15T20:15:00.706Z",
* "createdBy": "Ann6LewA",
* "content": "Duly noted"
* }
* }
Channel ID Format: uuid
The ID of the channel
Optional
completedCompleted at Format: date-time
The ISO 8601 timestamp that the list item was completed at
Optional
completedCompleted by
The ID of the user who completed this list item
Created at Format: date-time
The ISO 8601 timestamp that the list item was created at
Created by
The ID of the user who created this list item (Note: If this event has createdByWebhookId
present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)
Optional
createdCreated by Webhook ID
The ID of the webhook who created this list item, if it was created by a webhook
Format: uuid
The ID of the list item
Optional
mentions?: components["schemas"]["Mentions"]Message Format: markdown
The message of the list item
Optional
note?: { Note Format: markdown
The note of the list item
Created at Format: date-time
The ISO 8601 timestamp that the note was created at. If this field is populated, then there's a note associated with the list item
Created by
The ID of the user who created this note
Optional
mentions?: components["schemas"]["Mentions"]Optional
updatedUpdated at Format: date-time
The ISO 8601 timestamp that the note was updated at, if relevant
Optional
updatedUpdated by
The ID of the user who updated this note
Optional
parentFormat: uuid
The ID of the parent list item if this list item is nested
Server ID
The ID of the server
Optional
updatedUpdated at Format: date-time
The ISO 8601 timestamp that the list item was updated at, if relevant
Optional
updatedUpdated by
The ID of the user who updated this list item
{
* "id": "00000000-0000-0000-0000-000000000000",
* "serverId": "wlVr3Ggl",
* "channelId": "00000000-0000-0000-0000-000000000000",
* "message": "Remember to say hello **world**!",
* "createdAt": "2021-06-15T20:15:00.706Z",
* "createdBy": "Ann6LewA",
* "note": {
* "createdAt": "2021-06-15T20:15:00.706Z",
* "createdBy": "Ann6LewA"
* }
* }
Channel ID Format: uuid
The ID of the channel
Optional
completedCompleted at Format: date-time
The ISO 8601 timestamp that the list item was completed at
Optional
completedCompleted by
The ID of the user who completed this list item
Created at Format: date-time
The ISO 8601 timestamp that the list item was created at
Created by
The ID of the user who created this list item (Note: If this event has createdByWebhookId
present, this field will still be populated, but can be ignored. In this case, the value of this field will always be Ann6LewA)
Optional
createdCreated by Webhook ID
The ID of the webhook who created this list item, if it was created by a webhook
Format: uuid
The ID of the list item
Optional
mentions?: components["schemas"]["Mentions"]Message Format: markdown
The message of the list item
Optional
note?: { Created at Format: date-time
The ISO 8601 timestamp that the note was created at. If this field is populated, then there's a note associated with the list item
Created by
The ID of the user who created this note
Optional
updatedUpdated at Format: date-time
The ISO 8601 timestamp that the note was updated at, if relevant
Optional
updatedUpdated by
The ID of the user who updated this note
Optional
parentFormat: uuid
The ID of the parent list item if this list item is nested
Server ID
The ID of the server
Optional
updatedUpdated at Format: date-time
The ISO 8601 timestamp that the list item was updated at, if relevant
Optional
updatedUpdated by
The ID of the user who updated this list item
Metadata of who or what is mentioned in content
{
* "users": [
* {
* "id": "Ann6LewA"
* }
* ],
* "channels": [
* {
* "id": "00000000-0000-0000-0000-000000000000"
* }
* ],
* "roles": [
* {
* "id": 591232
* }
* ],
* "everyone": true,
* "here": true
* }
Optional
channels?: { Channels
Info on mentioned channels
Optional
everyone?: booleanEveryone
If
was mentioned
Optional
here?: booleanHere
If
was mentioned
Optional
roles?: { Roles
Info on mentioned roles
Optional
users?: { Users
Info on mentioned users
{
* "id": "wlVr3Ggl",
* "type": "community",
* "name": "Guilded",
* "url": "Guilded-Official",
* "about": "The Official Guilded Server! For devs, friends, and fans alike!",
* "ownerId": "Ann6LewA",
* "createdAt": "2018-10-05T20:15:00.706Z",
* "isVerified": true,
* "timezone": "America/Los Angeles (PST/PDT)"
* }
Optional
about?: stringDescription
The description associated with the server
Optional
avatar?: stringAvatar Format: media-uri
The avatar image associated with the server
Optional
banner?: stringBanner Format: media-uri
The banner image associated with the server
Created at Format: date-time
The ISO 8601 timestamp that the server was created at
Optional
defaultChannel ID Format: uuid
The channel ID of the default channel of the server. This channel is defined as the first chat or voice channel in the left sidebar of a server in our UI. This channel is useful for sending welcome messages, though note that a bot may not have permissions to interact with this channel depending on how the server is configured.
Server ID
The ID of the server
Optional
isIs verified
The verified status of the server
Server name
The name given to the server
Created by
The ID of the user who created this server
Optional
timezone?: stringTimezone
The timezone associated with the server
Optional
type?: "clan" | "community" | "friends" | "guild" | "organization" | "other" | "streaming" | "team"Server type
The type of server designated from the server's settings page
Optional
url?: stringServer URL
The URL that the server can be accessible from. For example, a value of "Guilded-Official" means the server can be accessible from https://www.guilded.gg/Guilded-Official
{
* "id": "00000000-0000-0000-0000-000000000000",
* "type": "chat",
* "name": "The Dank Cellar",
* "topic": "Dank memes ONLY",
* "createdAt": "2021-06-15T20:15:00.706Z",
* "createdBy": "Ann6LewA",
* "serverId": "wlVr3Ggl",
* "groupId": "ZVzBo83p"
* }
Optional
archivedArchived at Format: date-time
The ISO 8601 timestamp that the channel was archived at, if relevant
Optional
archivedArchived by
The ID of the user who archived this channel
Optional
categoryOnly relevant for server channels
Created at Format: date-time
The ISO 8601 timestamp that the channel was created at
Created by
The ID of the user who created this channel
Group ID
The ID of the group
Channel ID Format: uuid
The ID of the channel
Optional
isIs public
Whether the channel can be accessed from users who are not member of the server
false
The name of the channel
Optional
parentChannel ID Format: uuid
ID of the parent channel or parent thread, if present. Only relevant for server channels
Server ID
The ID of the server
Optional
topic?: stringThe topic of the channel
The type of channel. This will determine what routes to use for creating content in a channel. For example, if this "chat", then one must use the routes for creating channel messages
Optional
updatedUpdated at Format: date-time
The ISO 8601 timestamp that the channel was updated at, if relevant
{
* "user": {
* "id": "Ann6LewA",
* "type": "user",
* "name": "Leopold Stotch",
* "createdAt": "2021-06-15T20:15:00.706Z"
* },
* "roleIds": [],
* "nickname": "Professor Chaos",
* "joinedAt": "2021-07-15T20:15:00.706Z"
* }
Optional
isIs owner
false
Created at Format: date-time
The ISO 8601 timestamp that the member was created at
Optional
nickname?: stringNickname
Role IDs
{
* "user": {
* "id": "Ann6LewA",
* "type": "user",
* "name": "Leopold Stotch"
* },
* "reason": "More toxic than a poison Pokémon",
* "createdAt": "2021-06-15T20:15:00.706Z",
* "createdBy": "Ann6LewA"
* }
Created at Format: date-time
The ISO 8601 timestamp that the server member ban was created at
Created by
The ID of the user who created this server member ban
Optional
reason?: stringReason
The reason for the ban as submitted by the banner
{
* "user": {
* "id": "Ann6LewA",
* "type": "user",
* "name": "Leopold Stotch"
* },
* "roleIds": []
* }
Role IDs
{
* "type": "roblox",
* "userId": "Ann6LewA",
* "handle": "builderman",
* "serviceId": "156",
* "createdAt": "2006-03-08T20:15:00.706Z"
* }
Created at Format: date-time
The ISO 8601 timestamp that the social link was created at
Optional
handle?: stringThe handle of the user within the external service
Optional
serviceThe unique ID that represents this member's social link within the external service
Social link type
The type of social link that Guilded supports. Depending on this value, handle
or serviceId
may or may not be present
User ID
The ID of the user that the social link is associated with
{
* "id": "Ann6LewA",
* "type": "user",
* "name": "Leopold Stotch",
* "createdAt": "2021-06-15T20:15:00.706Z"
* }
Optional
avatar?: stringAvatar Format: media-uri
The avatar image associated with the user
Optional
banner?: stringBanner Format: media-uri
The banner image associated with the user
Created at Format: date-time
The ISO 8601 timestamp that the user was created at
User ID
The ID of the user
User name
The user's name
Optional
type?: "bot" | "user"User type
The type of user. If this property is absent, it can assumed to be of type user
{
* "id": "Ann6LewA",
* "type": "user",
* "name": "Leopold Stotch"
* }
Optional
avatar?: stringAvatar Format: media-uri
The avatar image associated with the user
User ID
The ID of the user
User name
The user's name
Optional
type?: "bot" | "user"User type
The type of user. If this property is absent, it can assumed to be of type user
{
* "id": "00000000-0000-0000-0000-000000000000",
* "serverId": "wlVr3Ggl",
* "channelId": "00000000-0000-0000-0000-000000000000",
* "name": "E-102 Gamma",
* "createdAt": "2021-06-15T20:15:00.706Z",
* "createdBy": "Ann6LewA"
* }
Optional
avatar?: stringAvatar Format: media-uri
The avatar image associated with the webhook
Channel ID Format: uuid
The ID of the channel
Created at Format: date-time
The ISO 8601 timestamp that the webhook was created at
Created by
The ID of the user who created this webhook
Optional
deletedDeleted at Format: date-time
The ISO 8601 timestamp that the webhook was deleted at
Webhook ID Format: uuid
The ID of the webhook
Name
The name of the webhook
Server ID
The ID of the server
Optional
token?: stringToken
The token of the webhook
Optional
d?: Record<string, never>Data
Data of any form depending on the underlying event
Opcode
An operation code corresponding to the nature of the sent message (for example, success, failure, etc.)
Optional
s?: stringMessage ID
Message ID used for replaying events after a disconnect
Optional
t?: stringEvent name
Event name for the given message
Generated using TypeDoc
Server ID
Description
The ID of the server