Full list of page profile fields you can subscribe to. Fields of this topic require at least one page admin to grant the 'manage_pages' permission to your app. The page admin also needs to have at least moderator privileges in order to receive all content.
messaging_account_linking
MessengerAccountLinkField
Fields
Field | Description |
---|
field
string | Name of the updated field
|
message_deliveries
MessengerMessageDeliveryReceiptField
Fields
Field | Description |
---|
field
string | Name of the updated field
|
message_echoes
MessengerMessageEchoField
Fields
Field | Description |
---|
field
string | Name of the updated field
|
message_reads
MessengerMessageReadReceiptField
Fields
Field | Description |
---|
field
string | Name of the updated field
|
messages
MessengerMessagesField
Fields
Field | Description |
---|
field
string | Name of the updated field
|
messaging_optins
MessengerNotificationMessagesOptinField
Fields
Field | Description |
---|
field
string | Name of the updated field
|
messaging_optins
MessengerOneTimeOptinField
Fields
Field | Description |
---|
field
string | Name of the updated field
|
messaging_policy_enforcement
MessengerPolicyField
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
object | value
|
recipient
IDName | recipient
|
id
id | ID
|
name
string | Name
|
timestamp
unsigned integer | timestamp
|
policy_enforcement
MessengerCommercePolicyData | policy_enforcement
|
action
string | action
|
reason
string | reason
|
message_reactions
MessengerReactionsField
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
object | value
|
sender
MessengerParticipantID | sender
|
id
numeric string | id
|
recipient
MessengerParticipantID | recipient
|
id
numeric string | id
|
timestamp
unsigned integer | timestamp
|
reaction
object | reaction
|
mid
string | mid
|
action
enum | action
|
emoji
string | emoji
|
reaction
enum | reaction
|
messaging_referrals
MessengerReferralField
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
object | value
|
sender
MessengerCommerceSenderData | sender
|
recipient
IDName | recipient
|
id
id | ID
|
name
string | Name
|
timestamp
unsigned integer | timestamp
|
referral
MessengerCommerceReferralData | referral
|
ref
string | The optional ref attribute set in the referrer.
|
source
string | The source of the referral. Supported values:
ADS
SHORTLINK
CUSTOMER_CHAT_PLUGIN
|
type
string | The referral type. Currently supports OPEN_THREAD.
|
ad_id
string | the id of the ad
|
referer_uri
string | The URI of the site where the message was sent in the Facebook chat plugin.
|
source_id
string | the id of the source
|
is_guest_user
string | A flag indicating whether the user is a guest user from Facebook Chat Plugin
|
ads_context_data
MessengerCommerceAdsContextData | The data contaning information about the CTM ad, the user initiated the thread from.
|
ad_title
string | ad_title
|
post_id
string | post_id
|
ad_body_text
string | ad_body_text
|
ad_subtitle
string | ad_subtitle
|
photo_url
string | photo_url
|
product_id
string | product_id
|
retailer_id
string | retailer_id
|
video_url
string | video_url
|
affiliation
Describes changes to a page's Affliation profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
attire
Describes changes to a page's Attire profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
awards
Describes changes to a page's Awards profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
bio
Describes changes to a page's Biography profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
birthday
Describes changes to a page's Birthday profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
category
Describes changes to a page's Category field. There can be up to three categories describing a page's topic, business, or person.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
enum | The result value.
|
page_change_proposal
Data for page change proposal.
Fields
Field | Description |
---|
action
enum | The action of the proposal, can be created, accepted_manually, rejected_manually and accepted_automatically
|
field
string | Name of the updated field
|
value
| The contents of the proposal
|
id
numeric string | The ID of the proposal
|
upcoming_change_info
| The upcoming change info of this proposal if the proposal will be automatically accepted
|
id
numeric string | The ID of the upcoming change
|
effective_time
datetime | The time when the upcoming change will become effective
|
timer_status
enum | The status of the timer associated with this change
|
category
string | The category of the proposed change
|
current_value
string | The current value for this category
|
proposed_value
string | The proposed value for this category
|
acceptance_status
enum | Indicate whether it was accepted or rejected only meaningful when the proposal is not pending
|
company_overview
Describes changes to a page's Company Overview profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
string | The result value.
|
culinary_team
Describes changes to a page's Culinary Team profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
current_location
Describes changes to a page's Current Location profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
description
Describes changes to a page's Story Description profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
email
Describes changes to a page's Email profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
feed
Describes nearly all changes to a Page's feed, such as Posts, shares, likes, etc. The values received depend on the types of changes made to the Page's feed. Webhooks are not sent for Ad Posts, but are sent for Comments on Ad Posts. Notifications for Page likes will only be sent for Pages that have fewer than 10K likes.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
object | The contents of the update
|
edited_time
datetime | edited_time
|
from
object | The sender information
|
id
numeric string | The ID of the sender
|
name
string | The name of the sender
|
post
| Provide additional content about a post such as 'type' (e.g. photo, video), 'status_type' (e.g. added_photos), 'is_published' (e.g. true/false), 'updated_time', 'permalink_url', 'promotion_status' (e.g. inactive, extendable)
|
status_type
string | Description of the type of a status update.
|
is_published
bool | Indicates whether a scheduled post was published (applies to scheduled Page Post only, for users post and instanlty published posts this value is always true)
|
updated_time
datetime | The time the post was last updated, which occurs when a user comments on the post.
|
permalink_url
uri | The permanent static URL to the post on www.facebook.com. Example: https://www.facebook.com/FacebookforDevelopers/posts/10153449196353553
|
is_hidden
bool | Whether the post is hidden or not
|
link
string | The link to attached content
|
message
string | The message that is part of the content
|
photo
string | The link to an attached photo
|
photo_ids
list<id> | The IDs of the photos that were added to an album
|
photos
list<string> | The links to any attached photos
|
post_id
token with structure: Post ID | The post ID
|
story
string | The story—only logged for a milestone item
|
title
string | The title—only logged for a milestone item
|
video
string | The link to an attached video
|
video_flag_reason
int32 | The code why the video is flagged. Available when a video is blocked, muted, or unblocked. (Reason Code 1: Your video may contain content that belongs to someone else)
|
action
string | The type of action taken
|
album_id
id | The album ID
|
comment_id
string | The comment ID
|
created_time
datetime | The timestamp of when the object was created
|
event_id
string | The ID of the event, if the feed post is an event creation story
|
item
enum {album, address, comment, connection, coupon, event, experience, group, group_message, interest, like, link, mention, milestone, note, page, picture, platform-story, photo, photo-album, post, profile, question, rating, reaction, relationship-status, share, status, story, timeline cover, tag, video} | The type of item
|
open_graph_story_id
id | The ID of the open graph object
|
parent_id
token with structure: Post ID | The parent ID
|
photo_id
id | The photo ID
|
reaction_type
string | The type of the user reaction
|
published
int32 | Whether the post is published
|
recipient_id
id | The recipient ID
|
share_id
id | The share ID
|
verb
enum {add, block, edit, edited, delete, follow, hide, mute, remove, unblock, unhide, update} | The type of action taken
|
video_id
id | The video ID
|
founded
Describes changes to a page's Founded profile field. This is different from the Start Date field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
string | The result value.
|
general_info
Describes changes to a page's General Information profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
string | The result value.
|
general_manager
Describes changes to a page's General Manager profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
hometown
Describes changes to a page's Homewtown profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
hours
Describes changes to a page's Hours profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
inbox_labels
PageInboxLabelsField
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
object | value
|
user
IDName | user
|
id
id | ID
|
action
enum | action
|
label
object | label
|
leadgen
Describes changes to a page's leadgen settings.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
object | Result values.
|
ad_id
id | The ID of the ad that the lead is part of
|
form_id
id | The ID of the form that the lead is part of
|
leadgen_id
id | The ID of the created lead
|
created_time
datetime | When the lead was created
|
page_id
id | The ID of the page that the lead belongs to
|
adgroup_id
id | The ID of the ad group that the lead is part of
|
live_videos
Describes changes to a page's live video status.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
object | Content of the update
|
id
id | The ID of the live video
|
status
enum | The status of the live video
|
location
Describes changes to a page's Location profile field, including the street address, city/state, or zip code fields.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
members
Describes changes to a page's Members profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
mention
Describes new mentions of a page, including mentions in comments, posts, etc. Some comment_id
and post_id
fields returned in mention webhooks may not be queried due to missing permissions including privacy issues.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
object | The contents of the update
|
community
| Workplace community which this group belongs to. Workplace only apps
|
id
numeric string | The Group ID
|
from
object | The sender information. Only availabe for Workplace community
|
id
numeric string | The ID of the sender
|
name
string | The name of the sender
|
link
string | The attachement link in the content that mentioned the page
|
message
string | The message that is part of the content that mentioned the page
|
message_tags
| Profiles tagged in the message. Workplace only apps
|
id
numeric string | ID of the profile
|
length
unsigned int32 | Number of characters in the text indicating the object
|
name
string | Name of the object
|
offset
unsigned int32 | The character offset in the source text of the text indicating the object
|
type
enum {user, page, event, group, application} | Type of the object
|
photo
string | The link to an attached photo in the content that mentioned the page
|
photos
list<string> | The links to attached photos in the content that mentioned the page
|
post_id
token with structure: Post ID | The ID of the post that mentioned the page
|
video
string | The link to an attached video in the content that mentioned the page
|
action
string | The type of action taken
|
album_id
id | The album ID
|
comment_id
string | The comment ID
|
created_time
datetime | The timestamp of when the object was created
|
event_id
string | The ID of the event, if the feed post is an event creation story
|
item
enum {album, address, comment, connection, coupon, event, experience, group, group_message, interest, like, link, mention, milestone, note, page, picture, platform-story, photo, photo-album, post, profile, question, rating, reaction, relationship-status, share, status, story, timeline cover, tag, video} | The type of item
|
open_graph_story_id
id | The ID of the open graph object
|
parent_id
token with structure: Post ID | The parent ID
|
photo_id
id | The photo ID
|
reaction_type
string | The type of the user reaction
|
published
int32 | Whether the post is published
|
recipient_id
id | The recipient ID
|
share_id
id | The share ID
|
verb
enum {add, block, edit, edited, delete, follow, hide, mute, remove, unblock, unhide, update} | The type of action taken
|
video_id
id | The video ID
|
mission
Describes changes to a page's Mission profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
string | The result value.
|
name
Describes changes to a page's Name profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
string | The page's name
|
page_about_story
PagePageAboutStoryField
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
object | The result values.
|
page_id
integer | Id of the page that the mutated page about story belongs to.
|
page_about_story_id
integer | Id of the page about story.
|
parking
Describes changes to a page's Parking profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
payment_options
Describes change to a page's Payment profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
personal_info
Describes changes to a page's Personal Information profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
personal_interests
Describes changes to a page's Personal Interests profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
phone
Describes changes to a page's Phone profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
picture
Describes changes to a page's profile picture.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
price_range
Describes changes to a page's Price Range profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
product_review
Describes changes to a page's product review settings.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
object | The result values.
|
product_item_id
id | The Product Item ID that this review is about
|
status
enum {NO_REVIEW, PENDING, REJECTED, APPROVED, OUTDATED} | The review status
|
reasons
list<string> | A list of reasons why the product item was rejected. Only set if the status is REJECTED.
|
products
Describes changes to a page's Products profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
string | The result value.
|
public_transit
Describes changes to a page's Public Transit profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
ratings
Describes changes to a page's ratings, including new ratings or a user's comments or reactions on a rating.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
object | The result values.
|
comment_id
string | The Comment ID if a comment was made on a rating
|
created_time
datetime | Timestamp for when the action took place
|
item
enum | The type of object that was updated
|
message
string | The Comment message if a comment was made on a rating
|
open_graph_story_id
id | Open Graph story ID of this rating for added or edited ratings
|
parent_id
token with structure: Post ID | The parent object ID, which can be the rating object or another comment
|
photo
string | The Photo URI if a photo was attached to a comment on a rating
|
post_id
token with structure: Post ID | The Post ID of the rating
|
rating
int32 | The star rating on created or edited ratings
|
review_text
(string) or (null) | The Review text on created or edited ratings
|
reaction_type
string | The user's reaction type, if the user selects a reaction for a rating
|
recommendation_type
enum | Whether or not this recommendation was "positive" or "negative"
|
reviewer_id
id | The ID of the reviewer on created or edited ratings
|
reviewer_name
string | The name of reviewer on created or edited ratings
|
sender_id
id | The ID of the user or page taking an action on a rating
|
sender_name
string | The name of the user or page taking an action on a rating
|
verb
enum {add, block, edit, edited, delete, follow, hide, mute, remove, unblock, unhide, update} | The type of action taken on a rating
|
page_upcoming_change
Webhooks data for page upcoming changes.
Fields
Field | Description |
---|
action
enum | The action happened for this upcoming change
|
field
string | Name of the updated field
|
value
| The contents of the upcoming change
|
page
| The associated page of this upcoming change
|
name
string | The name of the Page
|
effective_time
datetime | The time when the upcoming change will become effective
|
change_type
enum | The type of the upcoming change
|
timer_status
enum | The status of the timer associated with this change
|
proposal
| The proposal associated with the change, only valid when change_type is knowledge_proposal
|
category
string | The category of the proposed change
|
acceptance_status
enum | Indicate whether it was accepted or rejected only meaningful when the proposal is not pending
|
current_value
string | The current value for this category
|
proposed_value
string | The proposed value for this category
|
videos
Describes changes to the encoding status of a video on a page.
Fields
Field | Description |
---|
field
string | Name of the updated field
|
value
object | Content of the update
|
id
id | ID of the video
|
status
object | Status of the video
|
video_status
enum | Status of the video
|
website
Describes changes to a page's Website profile field.
Fields
Field | Description |
---|
field
string | Name of the updated field
|