Work with Events

The following are Apex classes for the Slack event types.

Represents a Slack event.

The following are methods for Event.

Signature

Return Value

Type: String

Signature

Type: String

The Slack.EventDispatcher class enables you to invoke an event handler such as in response to a user opening the app home in Slack.

Usage

Extend the EventDispatcher class and override the invoke() method.

Examples

This example shows an EventDispatcher that handles a user opening the app home.

EventDispatcher has the following method.

Invokes the event handler.

Signature

Parameters

parameters

Type: Slack.EventParameters

The event parameters for the handler.

context

Type: Slack.RequestContext

Describes the context in which a Slack event is invoked.


Represents Slack event parameters.

The following are constructors for EventParameters.

Creates an instance of the Slack.EventParameters class with the specified event, event ID, and event time.

Signature

Parameters

event

Type: Object

The event object, including the event type, timestamp, and triggering user. See Slack API: Event type structure.

eventId

Type: String

eventTime

Type: Integer

The following are methods for EventParameters.

Signature

Return Value

Type: Object

Signature

Return Value

Type: String

Signature

Return Value

Type: Integer

Represents the app_home_opened event. This event notifies your app when a user has entered your app home.

Usage

Use the app_home_opened event for an onboarding flow from your app home. See Onboarding with App Home.

This event is only sent to your app when a user has already clicked on your app. It's sent each time a user enters your app home.

Your Slack app must have a bot user configured and installed to use this event.

The following are methods for AppHomeOpenedEvent.

Signature

Return Value

Type: String

Gets the event timestamp.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Gets the name of the tab, for example, home.

Signature

Return Value

Type: String

Gets the type of event, for example, app_home_opened.

Signature

Return Value

Type: String

Gets the user who triggered the event.

Signature

Return Value

Type: String

Signature

Parameters

channel

Type: String

Return Value

Type: void

Sets the event timestamp.

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Sets the name of the tab.

Signature

Parameters

tab

Type: String

Return Value

Type: void

Sets the user who triggers the event.

Signature

Parameters

user

Type: String

Return Value

Type: void

Represents the app_mention event. This event allows your app to subscribe to message events that directly mention your app or bot.

The following are methods for AppMentionEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

Represents the emoji_changed event. This event notifies your app when a custom emoji has been added or changed.

The following are methods for EmojiChangedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: List

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

name

Type: String

Return Value

Type: void

Signature

Parameters

names

Type: List

Return Value

Type: void

Signature

Parameters

newName

Type: String

Return Value

Type: void

Signature

Parameters

oldName

Type: String

Return Value

Type: void

Signature

Parameters

subtype

Type: String

Return Value

Type: void

Signature

Parameters

value

Type: String

Return Value

Type: void

This event is sent when any property of a file is changed.

The following are methods for `FileChangeEvent'

Signature

Return Value

Type: Slack.FileChangeEvent.File

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

file

Type: Slack.FileChangeEvent.File

Return Value

Type: void

Signature

Parameters

fileId

Type: String

Return Value

Type: void

This event is sent to all connected clients for a user when that user uploads a file to Slack.

The following are methods for `FileCreatedEvent'

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.FileCreatedEvent.File

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

file

Type: Slack.FileCreatedEvent.File

Return Value

Type: void

Signature

Parameters

fileId

Type: String

Return Value

Type: void

Signature

Parameters

userId

Type: String

Return Value

Type: void

This event is sent to all connected clients for a workspace when a file is deleted.

The following are methods for `FileDeletedEvent'

Signature

Return Value

Type: List

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

channelIds

Type: List

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

fileId

Type: String

Return Value

Type: void

This event is sent when a file is made public.

The following are methods for `FilePublicEvent'

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.FilePublicEvent.File

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

file

Type: Slack.FilePublicEvent.File

Return Value

Type: void

Signature

Parameters

fileId

Type: String

Return Value

Type: void

Signature

Parameters

userId

Type: String

Return Value

Type: void

This event is sent when a file is shared.

The following are methods for `FileSharedEvent'

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.FileSharedEvent.File

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

channelId

Type: String

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

file

Type: Slack.FileSharedEvent.File

Return Value

Type: void

Signature

Parameters

fileId

Type: String

Return Value

Type: void

Signature

Parameters

userId

Type: String

Return Value

Type: void

The following are methods for `FileUnsharedEvent'

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.FileUnsharedEvent.File

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

channelId

Type: String

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

file

Type: Slack.FileUnsharedEvent.File

Return Value

Type: void

Signature

Parameters

fileId

Type: String

Return Value

Type: void

Signature

Parameters

userId

Type: String

Return Value

Type: void

Represents the bot_message event. This event notifies your app when a message was sent to a channel by a bot.

The following are methods for MessageBotEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

botId

Type: String

Return Value

Type: void

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

channelType

Type: String

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

text

Type: String

Return Value

Type: void

Signature

Parameters

threadTs

Type: String

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

username

Type: String

Return Value

Type: void

Represents the message_changed event. This event notifies your app when a message in a channel is edited.

The following are methods for MessageChangedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.MessageChangedEvent.Message

Signature

Return Value

Type: Slack.MessageChangedEvent.PreviousMessage

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Boolean

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

channelType

Type: String

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

hidden

Type: Boolean

Return Value

Type: void

Signature

Parameters

message

Type: Slack.MessageChangedEvent.Message

Return Value

Type: void

Signature

Parameters

previousMessage

Type: Slack.MessageChangedEvent.PreviousMessage

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

The following are methods for MessageChangedEvent.Edited.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

The following are methods for MessageChangedEvent.Message.

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.BotProfile

Signature

Return Value

Type: String

Signature

Return Value

Type: Boolean

Signature

Return Value

Type: List<Slack.File>

Signature

Return Value

Type: Boolean

Signature

Return Value

Type: Boolean

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: List

Signature

Return Value

Type: List<Slack.Reaction>

Signature

Return Value

Type: Integer

Signature

Return Value

Type: List

Signature

Return Value

Type: Integer

Signature

Return Value

Type: String

Signature

Return Value

Type: Boolean

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Boolean

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: List

Signature

Return Value

Type: Boolean

Signature

Parameters

botId

Type: String

Return Value

Type: void

Signature

Parameters

botProfile

Type: Slack.BotProfile

Return Value

Type: void

Signature

Parameters

clientMsgId

Type: String

Return Value

Type: void

Signature

Parameters

displayAsBot

Type: Boolean

Return Value

Type: void

Signature

Parameters

files

Type: List<Slack.File>

Return Value

Type: void

Signature

Parameters

hidden

Type: Boolean

Return Value

Type: void

Signature

Parameters

isLocked

Type: Boolean

Return Value

Type: void

Signature

Parameters

lastRead

Type: String

Return Value

Type: void

Signature

Parameters

latestReply

Type: String

Return Value

Type: void

Signature

Parameters

parentUserId

Type: String

Return Value

Type: void

Signature

Parameters

pinnedTo

Type: List

Return Value

Type: void

Signature

Parameters

reactions

Type: List<Slack.Reaction>

Return Value

Type: void

Signature

Parameters

replyCount

Type: Integer

Return Value

Type: void

Signature

Parameters

replyUsers

Type: List

Return Value

Type: void

Signature

Parameters

replyUsersCount

Type: Integer

Return Value

Type: void

Signature

Parameters

sourceTeam

Type: String

Return Value

Type: void

Signature

Parameters

starred

Type: Boolean

Return Value

Type: void

Signature

Parameters

subscribed

Type: Boolean

Return Value

Type: void

Signature

Parameters

subtype

Type: String

Return Value

Type: void

Signature

Parameters

team

Type: String

Return Value

Type: void

Signature

Parameters

text

Type: String

Return Value

Type: void

Signature

Parameters

threadTs

Type: String

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

upload

Type: Boolean

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

Signature

Parameters

userTeam

Type: String

Return Value

Type: void

Signature

Parameters

xFiles

Type: List

Return Value

Type: void

The following are methods for MesssageChangedEvent.PreviousMessage.

Signature

Return Value

Type: Slack.MessageChangedEvent.Message

Signature

Parameters

message

Type: Slack.MessageChangedEvent.Message

Return Value

Type: void

Represents the channel_join event. This event notifies your app when a user joins a channel.

The following are methods for MessageChannelJoinEvent.

Represents the channel_posting_permissions event. This event notifies your app that the posting permissions for a channel have been modified by a user.

The following are methods for MessageChannelPostingPermissionsEvent.

Represents the channel_topic event. This event notifies your app that the topic for a channel is changed.

The following are methods for MessageChannelTopicEvent.

Represents the message_deleted event. This event notifies your app when a message in a channel is deleted.

The following are methods for MessageDeletedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.MessageDeletedEvent.Message

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Boolean

Signature

Parameters

channel

Type: String

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

deletedTs

Type: String

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

hidden

Type: Boolean

Return Value

Type: void

Signature

Parameters

previousMessage

Type: Slack.MessageDeletedEvent.Message

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

The following are methods for MessageDeletedEvent.Edited.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

Represents the ekm_access_denied event. This event notifies your app when a piece of content is redacted by a workspace's administrators.

The following are methods for MessageEkmAccessDeniedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Boolean

Signature

Parameters

channel

Type: String

Signature

Parameters

channelType

Type: String

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

hidden

Type: Boolean

Return Value

Type: void

Signature

Parameters

text

Type: String

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

The following are methods for MessageEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.BotProfile

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.MessageEvent.Edited

Signature

Return Value

Type: String

Signature

Return Value

Type: List<Slack.File>

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

botId

Type: String

Return Value

Type: void

Description?

Signature

Parameters

botProfilem

Type: setBotProfile

Return Value

Type: void

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

channelType

Type: String

Return Value

Type: void

Signature

Parameters

clientMsgId

Type: String

Return Value

Type: void

Signature

Parameters

edited

Type: Slack.MessageEvent.Edited

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

files

Type: List<Slack.File>

Return Value

Type: void

Signature

Parameters

parentUserId

Type: String

Return Value

Type: void

Signature

Parameters

team

Type: String

Return Value

Type: void

Signature

Parameters

text

Type: String

Return Value

Type: void

Signature

Parameters

threadTs

Type: String

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

The following are methods for MessageEvent.Edited.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

Represents the file_share event. This event notifies your app when a file is shared in a channel.

The following are methods for MessageFileShareEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Boolean

Signature

Return Value

Type: String

Signature

Return Value

Type: List<Slack.File>

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Boolean

Signature

Return Value

Type: String

Signature

Return Value

Type: List<String>

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

channelType

Type: String

Return Value

Type: void

Signature

Parameters

displayAsBot

Type: Boolean

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

files

Type: List<Slack.File>

Return Value

Type: void

Signature

Parameters

parentUserId

Type: String

Return Value

Type: void

Signature

Parameters

text

Type: String

Return Value

Type: void

Signature

Parameters

threadTs

Type: String

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

upload

Type: Boolean

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

Signature

Parameters

xFiles

Type: List<String>

Return Value

Type: void

Represents the group_topic event. This event notifies your app when the topic for a private group is changed.

The following are methods for MessageGroupTopicEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

channelType

Type: String

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

text

Type: String

Return Value

Type: void

Signature

Parameters

topic

Type: String

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

Represents the me_message event. This event notifies your app when a channel member performs an action using the /me command.

The following are methods for MessageMeEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

botId

Type: String

Return Value

Type: void

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

channelType

Type: String

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

text

Type: String

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

username

Type: String

Return Value

Type: void

Represents the message_replied event. This event notifies your app when a channel's message is a reply to another message (its parent).

The following are methods for MessageRepliedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.MessageRepliedEvent.Message

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Boolean

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

hidden

Type: Boolean

Return Value

Type: void

Signature

Parameters

param

Type: String

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

The following are methods for MessageRepliedEvent.Edited.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

The following are methods for MessageRepliedEvent.Message.

Signature

Return Value

Type: String

Signature

Return Value

Type: List

Signature

Return Value

Type: List<Slack.Reaction>

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Boolean

Signature

Parameters

clientMsgId

Type: String

Return Value

Type: void

Signature

Parameters

pinnedTo

Type: List

Return Value

Type: void

Signature

Parameters

reactions

Type: List<Slack.Reaction>

Return Value

Type: void

Signature

Parameters

sourceTeam

Type: String

Return Value

Type: void

Signature

Parameters

starred

Type: Boolean

Return Value

Type: void

Signature

Parameters

subtype

Type: String

Return Value

Type: void

Signature

Parameters

team

Type: String

Return Value

Type: void

Signature

Parameters

text

Type: String

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

Signature

Parameters

userTeam

Type: String

Return Value

Type: void

Represents the thread_broadcast event. This event notifies your app when a user or bot user has indicated their reply should be broadcast to the whole channel.

The following are methods for MessageThreadBroadcastEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

channelType

Type: String

Return Value

Type: void

Signature

Parameters

clientMsgId

Type: String

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

text

Type: String

Return Value

Type: void

Signature

Parameters

threadTs

Type: String

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

Represents the pin_added event. This event notifies your app when an item is pinned in a channel.

The following are methods for PinAddedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.PinAddedEvent.Item

Signature

Return Value

Type: String

Signature

Return Value

Type: Integer

Signature

Return Value

Type: Slack.PinAddedEvent.PinnedInfo

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

channelId

Type: String

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

item

Type: Slack.PinAddedEvent.Item

Return Value

Type: void

Signature

Parameters

itemUser

Type: String

Return Value

Type: void

Signature

Parameters

pinCount

Type: Integer

Return Value

Type: void

Signature

Parameters

pinnedInfo

Type: Slack.PinAddedEvent.PinnedInfo

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

The following are methods for PinAddedEvent.Item.

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.FileComment

Signature

Return Value

Type: Integer

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.File

Signature

Return Value

Type: Slack.PinAddedEvent.Message

Signature

Return Value

Type: String

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

comment

Type: Slack.FileComment

Return Value

Type: void

Signature

Parameters

created

Type: Integer

Return Value

Type: void

Signature

Parameters

createdBy

Type: String

Return Value

Type: void

Signature

Parameters

file

Type: Slack.File

Return Value

Type: void

Signature

Parameters

message

Type: Slack.PinAddedEvent.Message

Return Value

Type: void

Signature

Parameters

type

Type: String

Return Value

Type: void

The following are methods for PinAddedEvent.Message.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.BotProfile

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: List

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

botId

Type: String

Return Value

Type: void

Signature

Parameters

botProfile

Type: Slack.BotProfile

Return Value

Type: void

Signature

Parameters

clientMsgId

Type: String

Return Value

Type: void

Signature

Parameters

permalink

Type: String

Return Value

Type: void

Signature

Parameters

pinnedTo

Type: List

Return Value

Type: void

Signature

Parameters

team

Type: String

Return Value

Type: void

Signature

Parameters

text

Type: String

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

type

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

The following are methods for PinAddedEvent.PinnedInfo.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Long

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

pinnedBy

Type: String

Return Value

Type: void

Signature

Parameters

pinnedTs

Type: Long

Return Value

Type: void

Represents the pin_removed event. This event notifies your app when a pin is removed from a channel.

The following are methods for PinRemovedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.PinRemovedEvent.Item

Signature

Return Value

Type: String

Signature

Return Value

Type: Integer

Signature

Return Value

Type: Slack.PinRemovedEvent.PinnedInfo

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Boolean

Signature

Parameters

channelId

Type: String

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

hasPins

Type: Boolean

Return Value

Type: void

Signature

Parameters

item

Type: Slack.PinRemovedEvent.Item

Return Value

Type: void

Signature

Parameters

param

Type: String

Return Value

Type: void

Signature

Parameters

pinCount

Type: Integer

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

The following are methods for PinRemovedEvent.Item.

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.FileComment

Signature

Return Value

Type: Integer

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.File

Signature

Return Value

Type: Slack.PinRemovedEvent.Message

Signature

Return Value

Type: String

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

comment

Type: Slack.FileComment

Return Value

Type: void

Signature

Parameters

created

Type: Integer

Return Value

Type: void

Signature

Parameters

createdBy

Type: String

Return Value

Type: void

Signature

Parameters

file

Type: Slack.File

Return Value

Type: void

Signature

Parameters

message

Type: Slack.PinRemovedEvent.Message

Return Value

Type: void

Signature

Parameters

type

Type: String

Return Value

Type: void

The following are methods for PinRemovedEvent.Message.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.BotProfile

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: List

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

appId

Type: String

Return Value

Type: void

Signature

Parameters

botId

Type: String

Return Value

Type: void

Signature

Parameters

botProfile

Type: Slack.BotProfile

Return Value

Type: void

Signature

Parameters

clientMsgId

Type: String

Return Value

Type: void

Signature

Parameters

permalink

Type: String

Return Value

Type: void

Signature

Parameters

pinnedTo

Type: List

Return Value

Type: void

Signature

Parameters

team

Type: String

Return Value

Type: void

Signature

Parameters

text

Type: String

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

type

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

The following are methods for PinRemovedEvent.PinnedInfo.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Long

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

pinnedBy

Type: String

Return Value

Type: void

Signature

Parameters

pinnedTs

Type: Long

Return Value

Type: void

Represents the reaction_added event. This event notifies your app when a reaction is added to an item.

The following are methods for ReactionAddedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.ReactionAddedEvent.Item

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

item

Type: Slack.ReactionAddedEvent.Item

Return Value

Type: void

Signature

Parameters

itemUser

Type: String

Return Value

Type: void

Signature

Parameters

reaction

Type: String

Return Value

Type: void

Sets the user who triggers the event.

Signature

Parameters

user

Type: String

Return Value

Type: void

The following are methods for ReactionAddedEvent.Item.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

file

Type: String

Return Value

Type: void

Signature

Parameters

fileComment

Type: String

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

type

Type: String

Return Value

Type: void

Represents the reaction_removed event. This event notifies your app when a reaction is removed from an item.

The following are methods for ReactionRemovedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.ReactionRemovedEvent.Item

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

item

Type: Slack.ReactionRemovedEvent.Item

Return Value

Type: void

Signature

Parameters

itemUser

Type: String

Return Value

Type: void

Signature

Parameters

reaction

Type: String

Return Value

Type: void

Sets the user who triggers the event.

Signature

Parameters

user

Type: String

Return Value

Type: void

The following are methods for ReactionRemovedEvent.Item.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

file

Type: String

Return Value

Type: void

Signature

Parameters

fileComment

Type: String

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

type

Type: String

Return Value

Type: void

Represents the star_added event. This event notifies your app when an item is starred.

The following are methods for StarAddedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.StarAddedEvent.Item

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

item

Type: Slack.StarAddedEvent.Item

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

The following are methods for StarAddedEvent.Edited.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

The following are methods for StarAddedEvent.Item.

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.FileComment

Signature

Return Value

Type: String

Signature

Return Value

Type: Long

Signature

Return Value

Type: Slack.File

Signature

Return Value

Type: Slack.StarAddedEvent.Messagering

Signature

Return Value

Type: String

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

comment

Type: Slack.FileComment

Return Value

Type: void

Signature

Parameters

createdBy

Type: String

Return Value

Type: void

Signature

Parameters

dateCreate

Type: Long

Return Value

Type: void

Signature

Parameters

file

Type: Slack.File

Return Value

Type: void

Signature

Parameters

message

Type: Slack.StarAddedEvent.Message

Return Value

Type: void

Signature

Parameters

type

Type: String

Return Value

Type: void

The following are methods for StarAddedEvent.Message.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.BotProfile

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.StarAddedEvent.Edited

Signature

Return Value

Type: String

Signature

Return Value

Type: List

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

appId

Type: String

Return Value

Type: void

Signature

Parameters

botId

Type: String

Return Value

Type: void

Signature

Parameters

botProfile

Type: Slack.BotProfile

Return Value

Type: void

Signature

Parameters

clientMsgId

Type: String

Return Value

Type: void

Signature

Parameters

edited

Type: Slack.StarAddedEvent.Edited

Return Value

Type: void

Signature

Parameters

permalink

Type: String

Return Value

Type: void

Signature

Parameters

pinnedTo

Type: List

Return Value

Type: void

Signature

Parameters

isStarred

Type: Boolean

Return Value

Type: void

Signature

Parameters

team

Type: String

Return Value

Type: void

Signature

Parameters

text

Type: String

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

type

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

Represents the star_removed event. This event notifies your app when a star is removed from an item.

The following are methods for StarRemovedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.StarRemovedEvent.Item

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

item

Type: Slack.StarRemovedEvent.Item

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

The following are methods for StarRemovedEvent.Edited.

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.StarRemovedEvent.Item

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

item

Type: Slack.StarRemovedEvent.Item

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

The following are methods for StarRemovedEvent.Item.

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.FileComment

Signature

Return Value

Type: String

Signature

Return Value

Type: Long

Signature

Return Value

Type: Slack.File

Signature

Return Value

Type: Slack.StarRemovedEvent.Message

Signature

Return Value

Type: String

Signature

Parameters

channel

Type: String

Return Value

Type: void

Signature

Parameters

comment

Type: Slack.FileComment

Return Value

Type: void

Signature

Parameters

createdBy

Type: String

Return Value

Type: void

Signature

Parameters

dateCreate

Type: Long

Return Value

Type: void

Signature

Parameters

file

Type: Slack.File

Return Value

Type: void

Signature

Parameters

message

Type: Slack.StarRemovedEvent.Message

Return Value

Type: void

Signature

Parameters

type

Type: String

Return Value

Type: void

The following are methods for StarRemovedEvent.Message.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.BotProfile

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.StarRemovedEvent.Edited

Signature

Return Value

Type: String

Signature

Return Value

Type: List

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

appId

Type: String

Return Value

Type: void

Signature

Parameters

botId

Type: String

Return Value

Type: void

Signature

Parameters

botProfile

Type: Slack.BotProfile

Return Value

Type: void

Signature

Parameters

clientMsgId

Type: String

Return Value

Type: void

Signature

Parameters

edited

Type: Slack.StarRemovedEvent.Edited

Return Value

Type: void

Signature

Parameters

permalink

Type: String

Return Value

Type: void

Signature

Parameters

pinnedTo

Type: List

Return Value

Type: void

Signature

Parameters

team

Type: String

Return Value

Type: void

Signature

Parameters

text

Type: String

Return Value

Type: void

Signature

Parameters

ts

Type: String

Return Value

Type: void

Signature

Parameters

type

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

Represents the subteam_created event. This event notifies your app when a user group has been added to the workspace.

The following are methods for SubteamCreatedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.SubteamCreatedEvent.Subteam

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

subteam

Type: Slack.SubteamCreatedEvent.Subteam

Return Value

Type: void

The following are methods for SubteamCreatedEvent.Prefs.

Signature

Return Value

Type: List

Signature

Return Value

Type: List

Signature

Parameters

channels

Type: List

Return Value

Type: void

Signature

Parameters

groups

Type: List

Return Value

Type: void

The following are methods for SubteamCreatedEvent.Subteam.

Signature

Return Value

Type: String

Signature

Return Value

Type: Integer

Signature

Return Value

Type: String

Signature

Return Value

Type: Integer

Signature

Return Value

Type: Integer

Signature

Return Value

Type: Integer

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.SubteamCreatedEvent.Prefs

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Integer

Signature

Return Value

Type: List

Signature

Return Value

Type: Boolean

Signature

Return Value

Type: Boolean

Signature

Return Value

Type: Boolean

Signature

Return Value

Type: Boolean

Signature

Parameters

autoProvision

Type: Boolean

Return Value

Type: void

Signature

Parameters

autoType

Type: String

Return Value

Type: void

Signature

Parameters

channelCount

Type: Integer

Return Value

Type: void

Signature

Parameters

createdBy

Type: String

Return Value

Type: void

Signature

Parameters

dateCreate

Type: Integer

Return Value

Type: void

Signature

Parameters

dateDelete

Type: Integer

Return Value

Type: void

Signature

Parameters

dateUpdate

Type: Integer

Return Value

Type: void

Signature

Parameters

deletedBy

Type: String

Return Value

Type: void

Signature

Parameters

description

Type: String

Return Value

Type: void

Signature

Parameters

enterpriseSubteamId

Type: String

Return Value

Type: void

Signature

Parameters

external

Type: Boolean

Return Value

Type: void

Signature

Parameters

handle

Type: String

Return Value

Type: void

Signature

Parameters

id

Type: String

Return Value

Type: void

Signature

Parameters

name

Type: String

Return Value

Type: void

Signature

Parameters

prefs

Type: Slack.SubteamCreatedEvent.Prefs

Return Value

Type: void

Signature

Parameters

isSubteam

Type: Boolean

Return Value

Type: void

Signature

Parameters

teamId

Type: String

Return Value

Type: void

Signature

Parameters

updatedBy

Type: String

Return Value

Type: void

Signature

Parameters

userCount

Type: Integer

Return Value

Type: void

Signature

Parameters

isUsergroup

Type: Boolean

Return Value

Type: void

Signature

Parameters

users

Type: List

Return Value

Type: void

Represents the subteam_members_changed event. This event notifies your app when the membership of an existing user group has changed.

The following are methods for SubteamMembersChangedEvent.

Signature

Return Value

Type: List<String>

Signature

Return Value

Type: Integer

Signature

Return Value

Type: Integer

Signature

Return Value

Type: Integer

Signature

Return Value

Type: String

Signature

Return Value

Type: List<String>

Signature

Return Value

Type: Integer

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

addedUsers

Type: List<String>

Return Value

Type: void

Signature

Parameters

addedUsersCount

Type: Integer

Return Value

Type: void

Signature

Parameters

datePreviousUpdate

Type: Integer

Return Value

Type: void

Signature

Parameters

dateUpdate

Type: Integer

Return Value

Type: void

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

removedUsers

Type: List<String>

Return Value

Type: void

Signature

Parameters

param

Type: String

Return Value

Type: void

Signature

Parameters

subteamId

Type: String

Return Value

Type: void

Signature

Parameters

teamId

Type: String

Return Value

Type: void

Represents the subteam_self_added event. This event notifies your app when you have been added to a user group.

The following are methods for SubteamSelfAddedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

subteamId

Type: String

Return Value

Type: void

Represents the subteam_self_removed event. This event notifies your app when you have been removed from a user group.

The following are methods for SubteamSelfRemovedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

param

Type: String

Return Value

Type: void

Represents the subteam_updated event. This event notifies you when an existing user group has been updated or its members changed.

The following are methods for SubteamUpdatedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.SubteamUpdatedEvent.Subteam

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

subteam

Type: Slack.SubteamUpdatedEvent.Subteam

Return Value

Type: void

The following are methods for SubteamUpdatedEvent.Prefs.

Signature

Return Value

Type: List

Signature

Return Value

Type: List

Signature

Parameters

channels

Type: List

Return Value

Type: void

Signature

Parameters

groups

Type: List

Return Value

Type: void

The following are methods for SubteamUpdatedEvent.Subteam.

Signature

Return Value

Type: String

Signature

Return Value

Type: Integer

Signature

Return Value

Type: String

Signature

Return Value

Type: Integer

Signature

Return Value

Type: Integer

Signature

Return Value

Type: Integer

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.SubteamUpdatedEvent.Prefs

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Integer

Signature

Return Value

Type: List

Signature

Return Value

Type: Boolean

Signature

Return Value

Type: Boolean

Signature

Return Value

Type: Boolean

Signature

Return Value

Type: Boolean

Signature

Parameters

autoProvision

Type: Boolean

Return Value

Type: void

Signature

Parameters

autoType

Type: String

Return Value

Type: void

Signature

Parameters

channelCount

Type: Integer

Return Value

Type: void

Signature

Parameters

createdBy

Type: String

Return Value

Type: void

Signature

Parameters

dateCreate

Type: Integer

Return Value

Type: void

Signature

Parameters

dateDelete

Type: Integer

Return Value

Type: void

Signature

Parameters

dateUpdate

Type: Integer

Return Value

Type: void

Signature

Parameters

deletedBy

Type: String

Return Value

Type: void

Signature

Parameters

description

Type: String

Return Value

Type: void

Signature

Parameters

enterpriseSubteamId

Type: String

Return Value

Type: void

Signature

Parameters

isExternal

Type: Boolean

Return Value

Type: void

Signature

Parameters

handle

Type: String

Return Value

Type: void

Signature

Parameters

id

Type: String

Return Value

Type: void

Signature

Parameters

name

Type: String

Return Value

Type: void

Signature

Parameters

prefs

Type: Slack.SubteamUpdatedEvent.Prefs

Return Value

Type: void

Signature

Parameters

isSubteam

Type: Boolean

Return Value

Type: void

Signature

Parameters

teamId

Type: String

Return Value

Type: void

Signature

Parameters

updatedBy

Type: String

Return Value

Type: void

Signature

Parameters

userCount

Type: Integer

Return Value

Type: void

Signature

Parameters

isUsergroup

Type: Boolean

Return Value

Type: void

Signature

Parameters

users

Type: List

Return Value

Type: void

Represents the team_access_granted event. This event notifies your app when access to a set of teams was granted to your org app.

The following are methods for TeamAccessGrantedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: List<String>

Signature

Return Value

Type: String

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

teamIds

Type: List<String>

Return Value

Type: void

Represents the team_access_revoked event. This event notifies your app when access to a set of teams was revoked from your org app.

The following are methods for TeamAccessRevokedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: List<String>

Signature

Return Value

Type: String

Signature

Parameters

eventTs

Type: String

Return Value

Type: void

Signature

Parameters

teamIds

Type: List<String>

Return Value

Type: void

Represents the team_domain_change event. This event notifies the app when the workspace domain has changed.

The following are methods for TeamDomainChangeEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

domain

Type: String

Return Value

Type: void

Signature

Parameters

url

Type: String

Return Value

Type: void

Represents the team_join event. This event notifies your app when a new member has joined.

The following are methods for TeamJoinEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.User

Signature

Parameters

user

Type: Slack.User

Return Value

Type: void

Represents the team_rename event. This event notifies your app when the workspace name has changed.

The following are methods for TeamRenameEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

name

Type: String

Return Value

Type: void

Represents the tokens_revoked event. This event notifies your app when the API tokens for your app were revoked.

The following are methods for TokensRevokedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.TokensRevokedEvent.Tokens

Signature

Return Value

Type: String

Signature

Parameters

tokens

Type: Slack.TokensRevokedEvent.Tokens

Return Value

Type: void

The following are methods for TokensRevokedEvent.Tokens.

Signature

Return Value

Type: List

Signature

Return Value

Type: List

Signature

Parameters

bot

Type: List

Return Value

Type: void

Signature

Parameters

oauth

Type: List

Return Value

Type: void

Represents the user_change event. This event notifies your app when a member's data has changed.

The following are methods for UserChangeEvent.

Signature

Return Value

Type: Integer

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: Slack.User

Signature

Parameters

cacheTs

Type: Integer

Return Value

Type: void

Represents the user_resource_denied event. This event notifies your app when a user resource was denied to your app.

The following are methods for UserResourceDeniedEvent.

Signature

Return Value

Type: List<String>

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

scopes

Type: List<String>

Return Value

Type: void

Signature

Parameters

triggerId

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

Deprecated. See Deprecated Events. Represents the user_resource_granted event. This event notifies your app when a user resource was granted to your app.

The following are methods for UserResourceGrantedEvent.

Signature

Return Value

Type: List<String>

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

scopes

Type: List<String>

Return Value

Type: void

Signature

Parameters

triggerId

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void

Deprecated. See Deprecated Events. Represents the user_resource_removed event. This event notifies your app when a user resource was removed from your app.

The following are methods for UserResourceRemovedEvent.

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Return Value

Type: String

Signature

Parameters

triggerId

Type: String

Return Value

Type: void

Signature

Parameters

user

Type: String

Return Value

Type: void