Connectors Reference

Slack

Slack is a team communication tool, that brings together all of your team communications in one place, instantly searchable and available wherever you go.

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

JoinChannel ([Optional]string name)

Join a channel

CreateChannel ([Optional]string name)

Create a channel

SetDND ([Optional]string num_minutes)

Set do not disturb

CreateGroup ([Optional]string name)

Create a group

PostMessage (string channel, string text, [advanced][Optional]string username, [advanced][Optional]boolean as_user, [advanced][Optional]string parse, [advanced][Optional]integer link_names, [advanced][Optional]boolean unfurl_links, [advanced][Optional]boolean unfurl_media, [advanced][Optional]string icon_url, [advanced][Optional]string icon_emoji)

Post message

ListChannels ()

List channels

 

Triggers:

Name

Summary

OnNewFile (string channel)

When a file is created

 

Objects:

Name

Summary

CreateChannelResponse

 

CreateGroupResponse

 

JoinChannelResponse

 

ListChannelsResponse

 

OnNewFileResponseItem

 

PostMessageResponse

Sent Message

SetDNDResponse

 

 

Actions:

JoinChannel

Summary: Join a channel

Description: Join a channel in slack.

 

Syntax:

Slack.JoinChannel ([Optional]string name)

 

Parameters:

Name

Type

Summary

Required

Related Action

name

string

(Name)

The name of the channel.

False

ListChannels

 

Returns:

          Type:JoinChannelResponse

 

CreateChannel

Summary: Create a channel

Description: Create a channel in slack.

 

Syntax:

Slack.CreateChannel ([Optional]string name)

 

Parameters:

Name

Type

Summary

Required

Related Action

name

string

(Name)

The name of the new channel.

False

 

Returns:

          Type:CreateChannelResponse

 

SetDND

Summary: Set do not disturb

Description: Set the do not disturb status for the user.

 

Syntax:

Slack.SetDND ([Optional]string num_minutes)

 

Parameters:

Name

Type

Summary

Required

Related Action

num_minutes

string

(Number of minutes)

The number of minutes to set do not disturb.

False

 

Returns:

          Type:SetDNDResponse

 

CreateGroup

Summary: Create a group

Description: Creates a group in slack.

 

Syntax:

Slack.CreateGroup ([Optional]string name)

 

Parameters:

Name

Type

Summary

Required

Related Action

name

string

(Name)

The name of the group.

False

 

Returns:

          Type:CreateGroupResponse

 

PostMessage

Summary: Post message

Description: This operation is used to post a message to the specified channel.

 

Syntax:

Slack.PostMessage (string channel, string text, [advanced][Optional]string username, [advanced][Optional]boolean as_user, [advanced][Optional]string parse, [advanced][Optional]integer link_names, [advanced][Optional]boolean unfurl_links, [advanced][Optional]boolean unfurl_media, [advanced][Optional]string icon_url, [advanced][Optional]string icon_emoji)

 

Parameters:

Name

Type

Summary

Required

Related Action

channel

string

(Channel Name)

Channel, private group, or IM channel to send message to. Can be a name(ex: #general) or an encoded ID.

True

ListChannels

text

string

(Message Text)

Body of the message to send. For formatting options, see https://api.slack.com/docs/formatting.

True

username

string

(Bot Name)

Name of the bot.

False

as_user

boolean

(Post As User)

Pass true to post the message as the authenticated user, instead of as a bot.

False

parse

string

(Parse Mode)Values: [full, none]

Change how messages are treated. For details, see https://api.slack.com/docs/formatting.

False

link_names

integer(int32)

(Link Names)

Find and link channel names and usernames.

False

unfurl_links

boolean

(Unfurl Links)

Pass true to enable unfurling of primarily text-based content.

False

unfurl_media

boolean

(Unfurl Media)

Pass false to disable unfurling of media content.

False

icon_url

string(uri)

(Icon Url)

URL to an image to use as an icon for this message.

False

icon_emoji

string

(Icon Emoji)

Emoji to use as an icon for this message.

False

 

Returns:

          Type:PostMessageResponse

          Summary: Sent Message

          Description: Details of the message posted to a Slack channel.

 

ListChannels

Summary: List channels

Description: List the channels in slack.

 

Syntax:

Slack.ListChannels ()

 

Returns:

          Type:ListChannelsResponse

 

Triggers:

Trigger OnNewFile

Summary: When a file is created

Description: When a file is created

 

Syntax:

Slack.OnNewFile (string channel)

 

Parameters:

Name

Type

Summary

Required

Related Action

channel

string

(Channel)

The name of the channel.

True

ListChannels

 

Returns:

          Type:array of (OnNewFileResponseItem)

 


 

CreateChannelResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

channel

Channel

Channel

 

 

Channel

Summary: Channel

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

The id of the channel.

name

string

Name

The name of channel.

 


 

CreateGroupResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

group

Group

Group

 

 

Group

Summary: Group

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

The id of the group.

name

string

Name

The name of the group.

 


 

JoinChannelResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

already_in_channel

boolean

Already in channel

Whether the user is already in the channel or not.

channel

Channel

Channel

 

 

Channel

Summary: Channel

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

The id of the channel.

name

string

Name

The name of channel.

 


 

ListChannelsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

channels

array of (ChannelsItem)

 

 

 

ChannelsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

The id of the channel.

name

string

Name

The name of channel.

 


 

OnNewFileResponseItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Id of the file

created

integer(int32)

Created

When the file was created.

name

string

Name

The name of the file.

title

string

Title

The title of the file.


 

PostMessageResponse

Summary: Sent Message

Description: Details of the message posted to a Slack channel.

 

          Properties:

Name

Type

Summary

ok

boolean

 

Indicates if the operation was successful.

channel

string

 

The channel which the message was posted to.

ts

string

 

yyyy-MM-ddTHH:mm:ss.fffZ

message

Message

Message

A channel message.

error

string

 

Details of the error messages, if any.

 

Message

Summary: Message

Description: A channel message.

 

          Properties:

Name

Type

Summary

text

string

 

Body of the message.

id

string

 

Unique identifier of the message.

user

string

 

Unique identifier of the user who posted the message.

created

integer(int64)

 

Unix timestamp for when the message is created.

is_user-deleted

boolean

 

Whether or not the message has been deleted.

 


 

SetDNDResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

snooze_enabled

boolean

Snooze Enabled

Whether snooze is enabled.