Safe Haskell	Safe-Inferred
Language	Haskell2010

Web.Slack.Experimental.Events.Types

Contents

Event responses

Description

Types for the Slack Events API.

Synopsis

data ChannelType
- = Channel
- | Group
- | Im
data AttachmentField = AttachmentField {
- title :: Text
- value :: Text
- short :: Maybe Bool
}
data AttachmentMessageBlockMessage = AttachmentMessageBlockMessage {
- blocks :: [SlackBlock]
}
data AttachmentMessageBlock = AttachmentMessageBlock {
- team :: TeamId
- channel :: ConversationId
- ts :: Text
- message :: AttachmentMessageBlockMessage
}
data DecodedMessageAttachment = DecodedMessageAttachment {
- fallback :: Maybe Text
- color :: Maybe Text
- pretext :: Maybe Text
- authorName :: Maybe Text
- authorLink :: Maybe Text
- authorIcon :: Maybe Text
- title :: Maybe Text
- titleLink :: Maybe Text
- text :: Maybe Text
- fields :: Maybe [AttachmentField]
- imageUrl :: Maybe Text
- thumbUrl :: Maybe Text
- footer :: Maybe Text
- footerIcon :: Maybe Text
- ts :: Maybe Text
- isMsgUnfurl :: Maybe Bool
- messageBlocks :: Maybe [AttachmentMessageBlock]
- authorId :: Maybe UserId
- channelId :: Maybe ConversationId
- channelTeam :: Maybe TeamId
- isAppUnfurl :: Maybe Bool
- appUnfurlUrl :: Maybe Text
- fromUrl :: Maybe Text
}
data MessageAttachment = MessageAttachment {
- decoded :: Maybe DecodedMessageAttachment
- raw :: Value
}
data MessageEvent = MessageEvent {
- blocks :: Maybe [SlackBlock]
- channel :: ConversationId
- text :: Text
- channelType :: ChannelType
- files :: Maybe [FileObject]
- user :: UserId
- ts :: Text
- threadTs :: Maybe Text
- appId :: Maybe Text
- botId :: Maybe Text
- attachments :: Maybe [MessageAttachment]
}
data BotMessageEvent = BotMessageEvent {
- blocks :: Maybe [SlackBlock]
- channel :: ConversationId
- text :: Text
- channelType :: ChannelType
- files :: Maybe [FileObject]
- ts :: Text
- threadTs :: Maybe Text
- appId :: Maybe Text
- botId :: Text
- attachments :: Maybe [MessageAttachment]
}
data MessageUpdateEvent = MessageUpdateEvent {
- message :: MessageEvent
}
data CreatedChannel = CreatedChannel {
- id :: ConversationId
- isChannel :: Bool
- name :: Text
- nameNormalized :: Text
- creator :: UserId
- created :: SystemTime
- isShared :: Bool
- isOrgShared :: Bool
- contextTeamId :: TeamId
}
data ChannelCreatedEvent = ChannelCreatedEvent {
- channel :: CreatedChannel
}
data ChannelLeftEvent = ChannelLeftEvent {
- actorId :: UserId
- channel :: ConversationId
- eventTs :: Text
}
data UrlVerificationPayload = UrlVerificationPayload {
- challenge :: Text
}
newtype EventId = EventId {
- unEventId :: Text
}
newtype MessageId = MessageId {
- unMessageId :: Text
}
data Event
data EventCallback = EventCallback {
- eventId :: EventId
- teamId :: TeamId
- eventTime :: SystemTime
- event :: Event
}
data SlackWebhookEvent
data UrlVerificationResponse = UrlVerificationResponse {
- challenge :: Text
}

Documentation

data ChannelType Source #

Not a ConversationType for some mysterious reason; this one has Channel as an option, which does not exist as a ConversationType. Slack, why?

Constructors

Channel
Group
Im

Instances

Instances details

FromJSON ChannelType Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser ChannelType # parseJSONList :: Value -> Parser [ChannelType] #
ToJSON ChannelType Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods toJSON :: ChannelType -> Value # toEncoding :: ChannelType -> Encoding # toJSONList :: [ChannelType] -> Value # toEncodingList :: [ChannelType] -> Encoding #
Show ChannelType Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> ChannelType -> ShowS # show :: ChannelType -> String # showList :: [ChannelType] -> ShowS #
Eq ChannelType Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods (==) :: ChannelType -> ChannelType -> Bool # (/=) :: ChannelType -> ChannelType -> Bool #

data AttachmentField Source #

https://api.slack.com/events/message/message_attachment Ported from https://github.com/slackapi/node-slack-sdk/blob/fc87d51/packages/types/src/message-attachments.ts

Since: 2.0.0.3

Constructors

AttachmentField
Fields title :: Text value :: Text short :: Maybe Bool

Instances

Instances details

FromJSON AttachmentField Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser AttachmentField # parseJSONList :: Value -> Parser [AttachmentField] #
Show AttachmentField Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> AttachmentField -> ShowS # show :: AttachmentField -> String # showList :: [AttachmentField] -> ShowS #

data AttachmentMessageBlockMessage Source #

Since: 2.0.0.3

Constructors

AttachmentMessageBlockMessage
Fields blocks :: [SlackBlock]

Instances

Instances details

FromJSON AttachmentMessageBlockMessage Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser AttachmentMessageBlockMessage # parseJSONList :: Value -> Parser [AttachmentMessageBlockMessage] #
Show AttachmentMessageBlockMessage Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> AttachmentMessageBlockMessage -> ShowS # show :: AttachmentMessageBlockMessage -> String # showList :: [AttachmentMessageBlockMessage] -> ShowS #

data AttachmentMessageBlock Source #

Since: 2.0.0.3

Constructors

AttachmentMessageBlock
Fields team :: TeamId channel :: ConversationId ts :: Text message :: AttachmentMessageBlockMessage

Instances

Instances details

FromJSON AttachmentMessageBlock Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser AttachmentMessageBlock # parseJSONList :: Value -> Parser [AttachmentMessageBlock] #
Show AttachmentMessageBlock Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> AttachmentMessageBlock -> ShowS # show :: AttachmentMessageBlock -> String # showList :: [AttachmentMessageBlock] -> ShowS #

data DecodedMessageAttachment Source #

https://api.slack.com/events/message/message_attachment Ported from https://github.com/slackapi/node-slack-sdk/blob/fc87d51/packages/types/src/message-attachments.ts

Since: 2.0.0.3

Constructors

DecodedMessageAttachment

Fields

fallback :: Maybe Text
color :: Maybe Text
pretext :: Maybe Text
authorName :: Maybe Text
authorLink :: Maybe Text
authorIcon :: Maybe Text
title :: Maybe Text
titleLink :: Maybe Text
text :: Maybe Text
fields :: Maybe [AttachmentField]
imageUrl :: Maybe Text
thumbUrl :: Maybe Text
footer :: Maybe Text
footerIcon :: Maybe Text
ts :: Maybe Text
isMsgUnfurl :: Maybe Bool
messageBlocks :: Maybe [AttachmentMessageBlock]
unfurled message blocks
authorId :: Maybe UserId
channelId :: Maybe ConversationId
channelTeam :: Maybe TeamId
isAppUnfurl :: Maybe Bool
appUnfurlUrl :: Maybe Text
fromUrl :: Maybe Text

Instances

Instances details

FromJSON DecodedMessageAttachment Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser DecodedMessageAttachment # parseJSONList :: Value -> Parser [DecodedMessageAttachment] #
Show DecodedMessageAttachment Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> DecodedMessageAttachment -> ShowS # show :: DecodedMessageAttachment -> String # showList :: [DecodedMessageAttachment] -> ShowS #

data MessageAttachment Source #

Constructors

MessageAttachment
Fields decoded :: Maybe DecodedMessageAttachment If the attachment can be decoded, this will be populated raw :: Value Slack does not document the attachment schema/spec very well and we can't decode many attachments. In these cases clients can work with the raw JSON.

Instances

Instances details

FromJSON MessageAttachment Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser MessageAttachment # parseJSONList :: Value -> Parser [MessageAttachment] #
Show MessageAttachment Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> MessageAttachment -> ShowS # show :: MessageAttachment -> String # showList :: [MessageAttachment] -> ShowS #

data MessageEvent Source #

https://api.slack.com/events/message and https://api.slack.com/events/message/file_share

Constructors

MessageEvent

Fields

blocks :: Maybe [SlackBlock]
channel :: ConversationId
text :: Text
channelType :: ChannelType
files :: Maybe [FileObject]
Since: 1.6.0.0
user :: UserId
ts :: Text
threadTs :: Maybe Text
Present if the message is in a thread
appId :: Maybe Text
Present if it's sent by an app
For mysterious reasons, this is NOT https://api.slack.com/events/message/bot_message, this is a regular message but with bot metadata. I Think it's because there *is* an associated user.
See botMessage.json golden parser test.
botId :: Maybe Text
Present if it's sent by a bot user
attachments :: Maybe [MessageAttachment]
Present if the message has attachments
Since: 2.0.0.3

Instances

Instances details

FromJSON MessageEvent Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser MessageEvent # parseJSONList :: Value -> Parser [MessageEvent] #
Show MessageEvent Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> MessageEvent -> ShowS # show :: MessageEvent -> String # showList :: [MessageEvent] -> ShowS #

data BotMessageEvent Source #

https://api.slack.com/events/message/bot_message This is similar to a MessageEvent but sent by a bot, for example messages that Reacji Channeler sends.

Since: 2.0.0.2

Constructors

BotMessageEvent

Fields

blocks :: Maybe [SlackBlock]
channel :: ConversationId
text :: Text
channelType :: ChannelType
files :: Maybe [FileObject]
ts :: Text
threadTs :: Maybe Text
Present if the message is in a thread
appId :: Maybe Text
Some (or all) bots also have an App ID
botId :: Text
Always present for bot_message subtype
attachments :: Maybe [MessageAttachment]
Present if the message has attachments
Since: 2.0.0.3

Instances

Instances details

FromJSON BotMessageEvent Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser BotMessageEvent # parseJSONList :: Value -> Parser [BotMessageEvent] #
Show BotMessageEvent Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> BotMessageEvent -> ShowS # show :: BotMessageEvent -> String # showList :: [BotMessageEvent] -> ShowS #

data MessageUpdateEvent Source #

https://api.slack.com/events/message/message_changed

FIXME(jadel): implement. This is mega cursed! in the normal message event the channel is called "channel" but here it is called "channelId" and also has a "channel_name" and "channel_team". Why?!

We don't decode these on this basis.

Constructors

MessageUpdateEvent
Fields message :: MessageEvent

Instances

Instances details

FromJSON MessageUpdateEvent Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser MessageUpdateEvent # parseJSONList :: Value -> Parser [MessageUpdateEvent] #
Show MessageUpdateEvent Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> MessageUpdateEvent -> ShowS # show :: MessageUpdateEvent -> String # showList :: [MessageUpdateEvent] -> ShowS #

data CreatedChannel Source #

FIXME: this might be a Channel, but may also be missing some fields/have bonus because Slack is cursed.

Constructors

CreatedChannel
Fields id :: ConversationId isChannel :: Bool name :: Text nameNormalized :: Text creator :: UserId created :: SystemTime isShared :: Bool isOrgShared :: Bool contextTeamId :: TeamId

Instances

Instances details

FromJSON CreatedChannel Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser CreatedChannel # parseJSONList :: Value -> Parser [CreatedChannel] #
Show CreatedChannel Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> CreatedChannel -> ShowS # show :: CreatedChannel -> String # showList :: [CreatedChannel] -> ShowS #

data ChannelCreatedEvent Source #

A channel was created.

https://api.slack.com/events/channel_created

Constructors

ChannelCreatedEvent
Fields channel :: CreatedChannel

Instances

Instances details

FromJSON ChannelCreatedEvent Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser ChannelCreatedEvent # parseJSONList :: Value -> Parser [ChannelCreatedEvent] #
Show ChannelCreatedEvent Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> ChannelCreatedEvent -> ShowS # show :: ChannelCreatedEvent -> String # showList :: [ChannelCreatedEvent] -> ShowS #

data ChannelLeftEvent Source #

You left a channel.

https://api.slack.com/events/channel_left

Constructors

ChannelLeftEvent
Fields actorId :: UserId channel :: ConversationId eventTs :: Text

Instances

Instances details

FromJSON ChannelLeftEvent Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser ChannelLeftEvent # parseJSONList :: Value -> Parser [ChannelLeftEvent] #
Show ChannelLeftEvent Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> ChannelLeftEvent -> ShowS # show :: ChannelLeftEvent -> String # showList :: [ChannelLeftEvent] -> ShowS #

data UrlVerificationPayload Source #

https://api.slack.com/events/url_verification

Constructors

UrlVerificationPayload
Fields challenge :: Text

Instances

Instances details

FromJSON UrlVerificationPayload Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser UrlVerificationPayload # parseJSONList :: Value -> Parser [UrlVerificationPayload] #
Show UrlVerificationPayload Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> UrlVerificationPayload -> ShowS # show :: UrlVerificationPayload -> String # showList :: [UrlVerificationPayload] -> ShowS #

newtype EventId Source #

Constructors

EventId
Fields unEventId :: Text

Instances

Instances details

FromJSON EventId Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser EventId # parseJSONList :: Value -> Parser [EventId] #
Show EventId Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> EventId -> ShowS # show :: EventId -> String # showList :: [EventId] -> ShowS #

newtype MessageId Source #

Constructors

MessageId
Fields unMessageId :: Text

Instances

Instances details

FromJSON MessageId Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser MessageId # parseJSONList :: Value -> Parser [MessageId] #
Show MessageId Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> MessageId -> ShowS # show :: MessageId -> String # showList :: [MessageId] -> ShowS #
Eq MessageId Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods (==) :: MessageId -> MessageId -> Bool # (/=) :: MessageId -> MessageId -> Bool #

data Event Source #

Constructors

EventMessage MessageEvent
EventBotMessage BotMessageEvent
EventMessageChanged
EventChannelJoinMessage	Weird message event of subtype channel_join. Sent "sometimes", according to a random Slack blog post from 2017: https://api.slack.com/changelog/2017-05-rethinking-channel-entrance-and-exit-events-and-messages Documentation: https://api.slack.com/events/message/channel_join
EventChannelCreated ChannelCreatedEvent
EventChannelLeft ChannelLeftEvent
EventUnknown Value

Instances

Instances details

FromJSON Event Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser Event # parseJSONList :: Value -> Parser [Event] #
Generic Event Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Associated Types type Rep Event :: Type -> Type # Methods from :: Event -> Rep Event x # to :: Rep Event x -> Event #
Show Event Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> Event -> ShowS # show :: Event -> String # showList :: [Event] -> ShowS #
type Rep Event Source #
Instance details Defined in Web.Slack.Experimental.Events.Types type Rep Event = D1 ('MetaData "Event" "Web.Slack.Experimental.Events.Types" "slack-web-2.0.1.0-JI08eViYuhzBizG5BueO5Q" 'False) ((C1 ('MetaCons "EventMessage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MessageEvent)) :+: (C1 ('MetaCons "EventBotMessage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BotMessageEvent)) :+: C1 ('MetaCons "EventMessageChanged" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "EventChannelJoinMessage" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EventChannelCreated" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChannelCreatedEvent))) :+: (C1 ('MetaCons "EventChannelLeft" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChannelLeftEvent)) :+: C1 ('MetaCons "EventUnknown" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value)))))

data EventCallback Source #

Constructors

EventCallback
Fields eventId :: EventId teamId :: TeamId eventTime :: SystemTime event :: Event

Instances

Instances details

FromJSON EventCallback Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser EventCallback # parseJSONList :: Value -> Parser [EventCallback] #
Show EventCallback Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> EventCallback -> ShowS # show :: EventCallback -> String # showList :: [EventCallback] -> ShowS #

data SlackWebhookEvent Source #

Constructors

EventUrlVerification UrlVerificationPayload
EventEventCallback EventCallback
EventUnknownWebhook Value

Instances

Instances details

FromJSON SlackWebhookEvent Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods parseJSON :: Value -> Parser SlackWebhookEvent # parseJSONList :: Value -> Parser [SlackWebhookEvent] #
Generic SlackWebhookEvent Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Associated Types type Rep SlackWebhookEvent :: Type -> Type # Methods from :: SlackWebhookEvent -> Rep SlackWebhookEvent x # to :: Rep SlackWebhookEvent x -> SlackWebhookEvent #
Show SlackWebhookEvent Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> SlackWebhookEvent -> ShowS # show :: SlackWebhookEvent -> String # showList :: [SlackWebhookEvent] -> ShowS #
type Rep SlackWebhookEvent Source #
Instance details Defined in Web.Slack.Experimental.Events.Types type Rep SlackWebhookEvent = D1 ('MetaData "SlackWebhookEvent" "Web.Slack.Experimental.Events.Types" "slack-web-2.0.1.0-JI08eViYuhzBizG5BueO5Q" 'False) (C1 ('MetaCons "EventUrlVerification" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UrlVerificationPayload)) :+: (C1 ('MetaCons "EventEventCallback" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EventCallback)) :+: C1 ('MetaCons "EventUnknownWebhook" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value))))

Event responses

By and large, Slack does not care about the response returned from event handlers, at least for the EventEventCallback as long as your service 200s. The exception is EventUrlVerification, which is expected to return a UrlVerificationResponse

data UrlVerificationResponse Source #

Response for url_verification.

Constructors

UrlVerificationResponse
Fields challenge :: Text

Instances

Instances details

ToJSON UrlVerificationResponse Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods toJSON :: UrlVerificationResponse -> Value # toEncoding :: UrlVerificationResponse -> Encoding # toJSONList :: [UrlVerificationResponse] -> Value # toEncodingList :: [UrlVerificationResponse] -> Encoding #
Show UrlVerificationResponse Source #
Instance details Defined in Web.Slack.Experimental.Events.Types Methods showsPrec :: Int -> UrlVerificationResponse -> ShowS # show :: UrlVerificationResponse -> String # showList :: [UrlVerificationResponse] -> ShowS #