Web.Slack.Experimental.Events.Types

Types for the Slack Events API.

Documentation

data ChannelType

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

FromJSON ChannelType

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser ChannelType

parseJSONList :: Value -> Parser [ChannelType]

ToJSON ChannelType

Defined in Web.Slack.Experimental.Events.Types

Methods

toJSON :: ChannelType -> Value

toEncoding :: ChannelType -> Encoding

toJSONList :: [ChannelType] -> Value

toEncodingList :: [ChannelType] -> Encoding

Show ChannelType

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> ChannelType -> ShowS

show :: ChannelType -> String

showList :: [ChannelType] -> ShowS

Eq ChannelType

Defined in Web.Slack.Experimental.Events.Types

Methods

(==) :: ChannelType -> ChannelType -> Bool

(/=) :: ChannelType -> ChannelType -> Bool

data AttachmentField

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

FromJSON AttachmentField

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser AttachmentField

parseJSONList :: Value -> Parser [AttachmentField]

Show AttachmentField

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> AttachmentField -> ShowS

show :: AttachmentField -> String

showList :: [AttachmentField] -> ShowS

data AttachmentMessageBlockMessage

Since: 2.0.0.3

Constructors

AttachmentMessageBlockMessage

Fields

• blocks :: [SlackBlock]

Instances

FromJSON AttachmentMessageBlockMessage

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser AttachmentMessageBlockMessage

parseJSONList :: Value -> Parser [AttachmentMessageBlockMessage]

Show AttachmentMessageBlockMessage

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> AttachmentMessageBlockMessage -> ShowS

show :: AttachmentMessageBlockMessage -> String

showList :: [AttachmentMessageBlockMessage] -> ShowS

data AttachmentMessageBlock

Since: 2.0.0.3

Constructors

AttachmentMessageBlock

Fields

• team :: TeamId
• channel :: ConversationId
• ts :: Text
• message :: AttachmentMessageBlockMessage

Instances

FromJSON AttachmentMessageBlock

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser AttachmentMessageBlock

parseJSONList :: Value -> Parser [AttachmentMessageBlock]

Show AttachmentMessageBlock

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> AttachmentMessageBlock -> ShowS

show :: AttachmentMessageBlock -> String

showList :: [AttachmentMessageBlock] -> ShowS

data DecodedMessageAttachment

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

FromJSON DecodedMessageAttachment

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser DecodedMessageAttachment

parseJSONList :: Value -> Parser [DecodedMessageAttachment]

Show DecodedMessageAttachment

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> DecodedMessageAttachment -> ShowS

show :: DecodedMessageAttachment -> String

showList :: [DecodedMessageAttachment] -> ShowS

data MessageAttachment

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

FromJSON MessageAttachment

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser MessageAttachment

parseJSONList :: Value -> Parser [MessageAttachment]

Show MessageAttachment

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> MessageAttachment -> ShowS

show :: MessageAttachment -> String

showList :: [MessageAttachment] -> ShowS

data MessageEvent

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

FromJSON MessageEvent

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser MessageEvent

parseJSONList :: Value -> Parser [MessageEvent]

Show MessageEvent

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> MessageEvent -> ShowS

show :: MessageEvent -> String

showList :: [MessageEvent] -> ShowS

data BotMessageEvent

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

FromJSON BotMessageEvent

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser BotMessageEvent

parseJSONList :: Value -> Parser [BotMessageEvent]

Show BotMessageEvent

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> BotMessageEvent -> ShowS

show :: BotMessageEvent -> String

showList :: [BotMessageEvent] -> ShowS

data MessageUpdateEvent

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

FromJSON MessageUpdateEvent

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser MessageUpdateEvent

parseJSONList :: Value -> Parser [MessageUpdateEvent]

Show MessageUpdateEvent

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> MessageUpdateEvent -> ShowS

show :: MessageUpdateEvent -> String

showList :: [MessageUpdateEvent] -> ShowS

data CreatedChannel

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

FromJSON CreatedChannel

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser CreatedChannel

parseJSONList :: Value -> Parser [CreatedChannel]

Show CreatedChannel

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> CreatedChannel -> ShowS

show :: CreatedChannel -> String

showList :: [CreatedChannel] -> ShowS

data ChannelCreatedEvent

A channel was created.

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

Constructors

ChannelCreatedEvent

Fields

• channel :: CreatedChannel

Instances

FromJSON ChannelCreatedEvent

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser ChannelCreatedEvent

parseJSONList :: Value -> Parser [ChannelCreatedEvent]

Show ChannelCreatedEvent

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> ChannelCreatedEvent -> ShowS

show :: ChannelCreatedEvent -> String

showList :: [ChannelCreatedEvent] -> ShowS

data ChannelLeftEvent

You left a channel.

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

Constructors

ChannelLeftEvent

Fields

• actorId :: UserId
• channel :: ConversationId
• eventTs :: Text

Instances

FromJSON ChannelLeftEvent

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser ChannelLeftEvent

parseJSONList :: Value -> Parser [ChannelLeftEvent]

Show ChannelLeftEvent

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> ChannelLeftEvent -> ShowS

show :: ChannelLeftEvent -> String

showList :: [ChannelLeftEvent] -> ShowS

data UrlVerificationPayload

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

Constructors

UrlVerificationPayload

Fields

• challenge :: Text

Instances

FromJSON UrlVerificationPayload

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser UrlVerificationPayload

parseJSONList :: Value -> Parser [UrlVerificationPayload]

Show UrlVerificationPayload

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> UrlVerificationPayload -> ShowS

show :: UrlVerificationPayload -> String

showList :: [UrlVerificationPayload] -> ShowS

newtype EventId

Constructors

EventId

Fields

• unEventId :: Text

Instances

FromJSON EventId

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser EventId

parseJSONList :: Value -> Parser [EventId]

Show EventId

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> EventId -> ShowS

show :: EventId -> String

showList :: [EventId] -> ShowS

newtype MessageId

Constructors

MessageId

Fields

• unMessageId :: Text

Instances

FromJSON MessageId

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser MessageId

parseJSONList :: Value -> Parser [MessageId]

Show MessageId

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> MessageId -> ShowS

show :: MessageId -> String

showList :: [MessageId] -> ShowS

Eq MessageId

Defined in Web.Slack.Experimental.Events.Types

Methods

(==) :: MessageId -> MessageId -> Bool

(/=) :: MessageId -> MessageId -> Bool

data Event

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

FromJSON Event

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser Event

parseJSONList :: Value -> Parser [Event]

Generic Event

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

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

type Rep Event

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

Constructors

EventCallback

Fields

• eventId :: EventId
• teamId :: TeamId
• eventTime :: SystemTime
• event :: Event

Instances

FromJSON EventCallback

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser EventCallback

parseJSONList :: Value -> Parser [EventCallback]

Show EventCallback

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> EventCallback -> ShowS

show :: EventCallback -> String

showList :: [EventCallback] -> ShowS

data SlackWebhookEvent

Constructors

EventUrlVerification UrlVerificationPayload

EventEventCallback EventCallback

EventUnknownWebhook Value

Instances

FromJSON SlackWebhookEvent

Defined in Web.Slack.Experimental.Events.Types

Methods

parseJSON :: Value -> Parser SlackWebhookEvent

parseJSONList :: Value -> Parser [SlackWebhookEvent]

Generic SlackWebhookEvent

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

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> SlackWebhookEvent -> ShowS

show :: SlackWebhookEvent -> String

showList :: [SlackWebhookEvent] -> ShowS

type Rep SlackWebhookEvent

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

Response for url_verification.

Constructors

UrlVerificationResponse

Fields

• challenge :: Text

Instances

ToJSON UrlVerificationResponse

Defined in Web.Slack.Experimental.Events.Types

Methods

toJSON :: UrlVerificationResponse -> Value

toEncoding :: UrlVerificationResponse -> Encoding

toJSONList :: [UrlVerificationResponse] -> Value

toEncodingList :: [UrlVerificationResponse] -> Encoding

Show UrlVerificationResponse

Defined in Web.Slack.Experimental.Events.Types

Methods

showsPrec :: Int -> UrlVerificationResponse -> ShowS

show :: UrlVerificationResponse -> String

showList :: [UrlVerificationResponse] -> ShowS