License	BSD3
Maintainer	Marcello Seri <marcello.seri@gmail.com>
Stability	experimental
Portability	unknown
Safe Haskell	None
Language	Haskell2010

Web.FBMessenger.API.Bot.WebhookAPI

Contents

Types
Functions

Description

This module contains types and helpers to parse the webhook requests coming from the Messenger Platform API. You can find a complete example with the source code of this library on github.

Synopsis

Types

data RemoteEvent Source

A webhook request contains a list of RemoteEvents, objects containing an id, a time and a list of messaging events.

Constructors

RemoteEvent
Fields evt_id :: Text Page ID of page evt_time :: Int Time of update evt_messaging :: [EventMessage] Array containing objects related to messaging

Instances

Eq RemoteEvent Source
Show RemoteEvent Source
Generic RemoteEvent Source
ToJSON RemoteEvent Source
FromJSON RemoteEvent Source
type Rep RemoteEvent Source

data RemoteEventList Source

This type wraps the content of a webhook request

Constructors

RemoteEventList [RemoteEvent]

Instances

Eq RemoteEventList Source
Show RemoteEventList Source
ToJSON RemoteEventList Source
FromJSON RemoteEventList Source

data EventMessage Source

This is an event message, for additional information refer to the official Messenger Platform API.

Constructors

EventMessage
Fields evtSenderId :: Text Sender user ID evtRecipientId :: Text Recipient user ID evtTimestamp :: Maybe Int evtContent :: EventMessageContent

Instances

Eq EventMessage Source
Show EventMessage Source
ToJSON EventMessage Source
FromJSON EventMessage Source

data EventMessageContent Source

Constructors

EmTextMessage Text Int Text	Message ID; Message sequence number; Message text.
EmStructuredMessage Text Int [EventMessageAttachment]	Message ID; Message sequence number; Array containing attachment data (image, video, audio)
EmAuth Text	data-ref parameter that was defined with the entry point
EmDelivery Int Int (Maybe [Text])	Sequence No.; Watermark: all messages that were sent before this timestamp were delivered; Array containing message IDs of messages that were delivered (optional)
EmPostback Text	Contains the postback payload that was defined with the button

Instances

Eq EventMessageContent Source
Show EventMessageContent Source
ToJSON EventMessageContent Source
FromJSON EventMessageContent Source

data EventMessageAttachment Source

Constructors

EmAttachment
Fields emType :: EventMessageAttachmentType emUrl :: Text

Instances

Eq EventMessageAttachment Source
Show EventMessageAttachment Source
ToJSON EventMessageAttachment Source
FromJSON EventMessageAttachment Source

data EventMessageAttachmentType Source

Constructors

EmImage
EmVideo
EmAudio

Instances

Eq EventMessageAttachmentType Source
Show EventMessageAttachmentType Source
ToJSON EventMessageAttachmentType Source
FromJSON EventMessageAttachmentType Source

Functions

extractMessagingEvents :: RemoteEventList -> [EventMessage] Source

Helper to extract all messaging events from the RemoteEventList in the webhook call body