CSharpDiscordWebhook 3.0.1
dotnet add package CSharpDiscordWebhook --version 3.0.1
NuGet\Install-Package CSharpDiscordWebhook -Version 3.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CSharpDiscordWebhook" Version="3.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CSharpDiscordWebhook" Version="3.0.1" />
<PackageReference Include="CSharpDiscordWebhook" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add CSharpDiscordWebhook --version 3.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: CSharpDiscordWebhook, 3.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package CSharpDiscordWebhook@3.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=CSharpDiscordWebhook&version=3.0.1
#tool nuget:?package=CSharpDiscordWebhook&version=3.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
CSharpDiscordWebhook
Simple C# written code to send messages embeds and files using discord webhooks
Getting started
Creating a webhook instance
using System;
using CSharpDiscordWebook;
using CSharpDiscordWebhook.Objects;
// For safety, never store the webhook url directly in your code!
string webhookUrl = Environment.GetEnvironmentVariable("URL_ENV_VAR");
DiscordWebhook webhook = new DiscordWebhook(webhookUrl);
// OR
DiscordWebhook webhook = new DiscordWebhook(webhook_id, webhook_token);
Sending a simple message
using System.Drawing;
await webhook.SendMessageAsync(new MessageBuilder
{
Content = "Hello, World!",
Username = "Sample Webhook",
Embeds = [
new EmbedBuilder
{
Title = "Embed 1",
Description = "Embed Description",
Color = Color.Red
},
new EmbedBuilder
{
Title = "Embed 2",
Color = Color.Green,
Fields = [
new EmbedFieldBuilder {
Name = "Field 1",
Value = "Value"
},
new EmbedFieldBuilder
{
Name = "Field 2",
Value = "Value"
}
]
}
],
Poll = new PollBuilder
{
Question = "Poll Question",
Answers = [
new PollAnswerBuilder { Text = "Answer 1", Emoji = new("1️⃣") },
new PollAnswerBuilder { Text = "Answer 2", Emoji = new("2️⃣") },
new PollAnswerBuilder { Text = "Answer 3", Emoji = new("3️⃣️") },
// Answers can also be provided as a simple string
"Answer 4",
"Answer 5"
],
Duration = TimeSpan.FromHours(1), // Minimum is 1
AllowMultiSelect = true
}
});
Adding mentions
await webhook.SendMessageAsync(new MessageBuilder
{
Content = "Mention user: <@user_id>, Mention channel: <#channel_id>",
AllowedMentions = new AllowedMentions
{
Types = [ AllowedMentionType.Users ]
}
});
Sending files
await message.SendMessageAsync(new MessageBuilder
{
Attachments = [
new FileAttachmentBuilder
{
Id = 0, // Required to be unique
Filename = "filename.txt",
Source = new FileInfo("path/to/file.txt"),
Parameters = {
Title = "File Title",
Size = 1024, // File length in bytes (doesn't seem to have any effect)
// More info can be found at https://en.wikipedia.org/wiki/Media_type
MimeType = "audio/wav",
// Audio parameters, only seem to be displayed on mobile devices
Duration = TimeSpan.FromSeconds(15),
Waveform = "...", // A base64 string containing the audio waveform
}
}
// You can also provide data directly from memory using
// StreamAttachmentBuilder
]
});
Editing messages
ulong messageId = 0;
// This function also supports Message objects instead of ID
// See the examples bellow to learn how to get a Message object
await webhook.EditMessageAsync(message_id, modify =>
{
modify.Content = "New Content";
// You can also remove or add new attachments
modify.Attachments.Remove(0);
ulong newAttachmentUniqueId = 1024;
modify.Attachments.Add(new AttachmentModify(newAttachmentUniqueId, "filename.txt")
{
Parameters = {
/* Same as the attachment example above */
},
// Here you need to set the data provider
StreamProvider = new FileAttachmentProvider()
{
Source = new FileInfo("/path/to/file.txt")
}
});
});
Getting a message
ulong messageId = 0;
WebhookResult<Message> result = await webhook.GetMessageAsync(messageId);
if(!result.Success)
{
// The reason can be read with
// result.Error.Message
return;
}
Message msg = result.Result!;
// webhook.SendMessageAsync can also return a message object
// but you need to set the wait argument to true
result = await webhook.SendMessageAsync(new MessageBuilder
{
/* Parameters */
}, wait: true);
/* Handle errors */
msg = result.Result!;
Other functions
// Get webhook info
WebhookResult<Webhook> result = await webhook.GetAsync();
// Modify webhook
result = await webhook.ModifyAsync(modify =>
{
modify.Name = "Default Username";
modify.Avatar = "url..."
});
// Delete webhook
bool deleted = await webhook.DeleteWebhookAsync();
// Delete a message
ulong messageId = 0;
bool deleted = await webhook.DeleteMessageAsync(messageId);
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- System.Text.Json (>= 10.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.