README
Provides a simple .Net client for using Slack's Incoming Webhooks URL's to send messages to a slack channel of your choosing.
The Webhooks API is pretty simple, but it always preferable to have a typed interface to use rather than an untyped (and undocumented) JSON object. So using this library should make it simpler to build a slack message and send it using a webhook URL.
Example
Foo
How to use
First install the nuget package:
1
PM> Install-Package SlackWebhook
Copied!
Next simply use the
SlackClient class to send a message:1
await new SlackClient(webhookUrl).SendAsync(b => b
2
.WithUsername("Slack Bot Name")
3
.WithIcon(IconType.Url, "http://my.host/bot_icon.png")
4
.WithText("Something very interesting just happened")
5
);
Copied!
How to obtain Incoming Webhook URL
In the above example i used the
webhookUrl which you obtain by adding the Incoming WebHooks app configuration to the channel you want to send messages to (each url is tied to a specific channel, so if you want to sent to different channels, just add multiple configurations).- 2.Under Post to Channel select the channel you want to send to
- 3.Press Add Incoming WebHooks integration
- 4.Now copy the Webhook URL
What is supported?
Besides the message, the Slack hook also allows attachments which are pretty neat. In the above example I used a few attachments and fields to illustrate some of the uses. Especially the attachment fields are a good way to include extra detail in a table-like structure (by setting
short flag on field, two fields will be shown in the attachment side-by-side for each row).My example was generated by this code:
1
await new SlackClient(webhookUrl).SendAsync(b => b
2
.WithText("Hello from *SlackWebhook*")
3
.WithUsername("SlackWebhook")
4
.WithIcon(IconType.Url, "https://raw.githubusercontent.com/micdah/SlackWebhook/master/icon.png")
5
.WithAttachment(a => a
6
.WithTitle("How to install")
7
.WithText("`PM> Install-Package SlackWebhook`")
8
.WithColor(Color.DarkSlateBlue))
9
.WithAttachment(a => a
10
.WithTitle("Find out more")
11
.WithText("Find out more by taking a look at github.com/micdah/SlackWebhook")
12
.WithLink("https://github.com/micdah/SlackWebhook")
13
.WithField(
14
"Use builder pattern",
15
"```\n" +
16
"await slackClient.SendASync(b => b\n" +
17
" .WithUsername(\"My Bot\")\n" +
18
" .WithText(\"Hello *World*\"));\n" +
19
"```")
20
.WithField(
21
"Use object initializer",
22
"```\n" +
23
"await slackClient.SendAsync(new SlackMessage {\n" +
24
" Username = \"My Bot\",\n" +
25
" Text = \"Hello *World*\"\n" +
26
"});\n" +
27
"```")));
Copied!
Documentation
- Interface of the
SlackClientimplementation used to send message - Inteface of the message builder used to configure your message
- Interface of the attachment builder used to configure attachments added to your message
Last modified 3yr ago