feat: add docs

bwmarrin · Sep 22, 2023 · 1fe44cc · 1fe44cc
1 parent 07838e8
commit 1fe44cc
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/webhook.go b/webhook.go
@@ -37,8 +37,10 @@ type WebhookParams struct {
 	AllowedMentions *MessageAllowedMentions `json:"allowed_mentions,omitempty"`
 	// Only MessageFlagsSuppressEmbeds and MessageFlagsEphemeral can be set.
 	// MessageFlagsEphemeral can only be set when using Followup Message Create endpoint.
-	Flags      MessageFlags `json:"flags,omitempty"`
-	ThreadName string       `json:"thread_name,omitempty"`
+	Flags MessageFlags `json:"flags,omitempty"`
+	// Name of the thread to create.
+	// NOTE: can only be set if webhook channel is a forum.
+	ThreadName string `json:"thread_name,omitempty"`
 }
 
 // WebhookEdit stores data for editing of a webhook message.