BizDoc.Social.Slack 8.3.5

Slack for BizDoc

BizDoc enables to push messages into Slack, and responds to actions on messages in Slack.

To utilize Slack messaging, add the following in program.cs.

builder.Services.AddBizDoc().AddSlack(o => {
	o.Token = "{bot-oauth-token}";
	o.ChannelId = e => "{channel-id}";
});


app.UseBizDoc().UseSlack();

Sockets

To enable socket for background communication, call UseSocket.

builder.Services.AddBizDoc().AddSlack(o => ..., 
	e => e.UseSocket(o => {
		Token = "{app-level-token}";
	}));

You can configure ProxySettings and retry policy on UseSocket options.

Remember to enable Socket Mode in app config, and use app-level token.

Responding to events

Developer can intercept Slack events within BizDoc, by setting the OnMessageReceived action.

builder.Services.AddBizDoc().
	AddSlack(..., e =>
		e.UseSocket(o =>
			o.OnMessageReceived = e => {
				if(e.Message is EventCallback ec && ec.Payload.Event is NewMessage msg)
					Debug.Write($"Message text '{msg.Text}'");
			}));

Events.

Message types.

To notify the user in response, set the event Response property as follows.

	e.Response.Text = Markdown($"*{ctx.Document.Number}* success!");

Service

Inject SlackService service to take action in Slack.

await _slackService.PostMessageAsync("channel-id", "Message!");

Intercept outgoing messages

Implement the OnMessagePost option in AddSlack() to change the format of an outgoing message.

Use the IDocumentContext to access form model using the GetModel() method.

using BizDoc.Slack.Models;

builder.Services.
	AddBizDoc(o => {
		o.ApplicationUrl = "{server-public-address}";
	}).
	AddSlack(o => {
		...
		o.OnMessagePost = e => {
			var dataModel = e.Context.GetModel<MyFormModel>();
	
			var section = new Section("form_section");
			section.Fields.Add(new Text(dataModel.Title));
		
			e.Request.Blocks.Add(section);
		}
	});

Block can be one of Section, ImageBlock, InputBlock, RichTextBlock or ActionsBlock, corresponding to Block Kit.

Element can be one of Input, DatePicker, Checkboxes, RadioButtons, Select, MultiSelect, Image, OverflowMenu, Button, ConversationsSelect, MultiConversationsSelect, ChannelsSelect or MultiChannelsSelect.

Use Text or Markdown to represent texts.

Commonly use Section, and Button as section Accessory for interaction.

Set the ApplicationUrl option to provide Slack user a link to open BizDoc on browser.

Components

Components can be found in bizdoc.slack.json file added to BizDoc server root folder.

Flow node

SlackMessage, posts a message to Slack channel when workflow reaches the node.

Type source