Reference Documentation

These docs provide a detailed reference for Messenger Platform components, including detailed lists of properties, as well as example and requests and responses.

Integration Components

APIs

• Attachment Upload API – Upload media to be used in multiple message types and notifications
• Handover Protocol API – Allow multiple apps to respond in a conversation
• Messaging Feature Review API – Check the review status for subscription messaging, and user gender, locale, and timezone
• Messaging Insights API – View insights for conversations and messages
• Messenger Profile API – Set up and manage welcome messages, persistent menus, and more for a Messenger profile
• Personas API – Create and manage personas for a Messenger profile
• Send API – Create and send quick replies, marketing messages, and freeform or templated messages

SDKs

• Messenger Extensions JavaScript SDK – Add and customize Messenger in a website

Webhook Events

Track the following actions:

• messages – A Page receives a message from a person or other Page
• message_deliveries – A message that a Page has sent has been delivered
• message_echoes – A Page receives a copy of the message that the Page has sent
• message_reads – The message a Page has sent has been read by the recipient
• messaging_account_linking – The Link Account or Unlink Account button have been tapped
• messaging_game_plays – A person played a round of Instant Games
• messaging_handovers – The ownership of a conversation has changed from one app to another
• messaging_optins – A person has opted in to receiving marketing messages from a Page
• messaging_policy_enforcement – A policy enforcement action will be or is taken on an app
• messaging_postbacks – A person clicks a postback or Get Started button, or persistent menu item
• messaging_referrals – A person sends a message in an existing conversation with a Page via an m.me link, or an ad
• standby – A Page receives a message but the app is not the current owner of the conversation

Conversation Components