Home

Welcome to the FaceBot wiki! FaceBot is a Java framework aimed to simplify the creation of event-driven bots on Facebook's Messenger Platform.

Overview

FaceBot is a framework designed to achieve the followings goals in mind:

• ease-of-use
• flexibility
• support for all the application life cycle

The architecture of FaceBot is based on two main components: the Event and the AutoReply.

An Event is a callback from Facebook's Messenger API. You can register from different callbacks during the setup of your Facebook application. You can find the full callback list here.

An AutoReply is the reply that a FaceBot generates in response of an event. The AutoReply will be associated to a specific event you define and it will send a reply to the user as soon as the event triggers. When creating an AutoReply you will only need to define the response that should be sent back to the user. The framework will take care of the data conversion and communication to Facebook.

The framework offers different instruments:

• ReplyFactory, a powerful DSL-like tool that allows the creation of message, action or even template answers with a little knowledge of the Facebook data model.
• FaceBotValidator, a tool that allows you to check the validity of the reply you built before sending it to Facebook.
• FaceBotMockMediator, a class which contains methods to test your bot offline. Combined with the FaceBotValidator, it makes a nice instrument for automatic testing of complex bots.

Index of Contents

• Event and AutoReply
• ReplyFactory
• FaceBotValidator and FaceBotMockMediator