Share via


Facebook [DEPRECATED]

Facebook API allows you to access and publish posts on your Facebook user account

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
Power Automate Standard All Power Automate regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Power Apps Standard All Power Apps regions except the following:
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
Connector Metadata
Publisher Microsoft
Website https://www.facebook.com/
Privacy policy https://www.facebook.com/privacy/explanation

This connector has been deprecated. We have replaced this with an open source example which users can extend and deploy as a custom connector for their purposes.

To use this integration, you will need an Facebook account.

Known Issues and Limitations

  1. The trigger When there is a new post on my timeline fires when only account owner adds post to the timeline.
  2. The trigger When there is a new post on my timeline does not work in LogicApps regions. We are woking with Facebook towards resolution.

Throttling Limits

Name Calls Renewal Period
API calls per connection 500 300 seconds
Frequency of trigger polls 1 120 seconds

Actions

Get feed from my timeline (V2) [DEPRECATED]

Gets the feeds from the logged in user's timeline (V2).

Get feed from my timeline [DEPRECATED]

Gets the feeds from the logged in user's timeline.

Get page feed (V2) [DEPRECATED]

Get posts from the feed of a specified page (V2).

Get page feed (V3) [DEPRECATED]

Get posts from the feed of a specified page (V3).

Get user or page timeline [DEPRECATED]

Get posts from a user or page timeline.

Get user timeline (V2) [DEPRECATED]

Get posts from a user's timeline (V2).

Get user timeline [DEPRECATED]

Get posts from a user's timeline.

Post to my timeline [DEPRECATED]

Post a status message to the logged in user's timeline.

Post to page (V2) [DEPRECATED]

Post a message to a Facebook Page as the logged in user (V2).

Post to page [DEPRECATED]

Post a message to a Facebook Page as the logged in user.

Get feed from my timeline (V2) [DEPRECATED]

Gets the feeds from the logged in user's timeline (V2).

Parameters

Name Key Required Type Description
Fields
fields string

Specify the fields you want returned. Example (id,name,picture).

Max posts
limit integer

Maximum number of posts to be retrieved.

With or without location
with string

Restrict the list of posts to only those with location attached.

Filter for the feeds returned
filter string

Retrieve only posts that match a particular stream filter.

Returns

List of feed items.

Get feed from my timeline [DEPRECATED]

Gets the feeds from the logged in user's timeline.

Parameters

Name Key Required Type Description
Fields
fields string

Specify the fields you want returned. Example (id,name,picture).

Max posts
limit integer

Maximum number of posts to be retrieved.

With or without location
with string

Restrict the list of posts to only those with location attached.

Filter for the feeds returned
filter string

Retrieve only posts that match a particular stream filter.

Returns

List of feed items.

Get page feed (V2) [DEPRECATED]

Get posts from the feed of a specified page (V2).

Parameters

Name Key Required Type Description
Page ID
pageId True string

Unique ID of the page from which posts have to be retrieved.

Max posts
limit integer

Maximum number of posts to be retrieved.

Include hidden posts
include_hidden boolean

Whether or not to include any posts that were hidden by the Page.

Fields
fields string

Specify the fields you want returned. Example (id,name,picture).

Returns

List of feed items.

Get page feed (V3) [DEPRECATED]

Get posts from the feed of a specified page (V3).

Parameters

Name Key Required Type Description
Page ID
pageId True string

Unique ID of the page from which posts have to be retrieved.

Max posts
limit integer

Maximum number of posts to be retrieved.

Include hidden posts
include_hidden boolean

Whether or not to include any posts that were hidden by the Page.

Fields
fields string

Specify the fields you want returned. Example (id,name,picture).

Returns

List of feed items.

Get user or page timeline [DEPRECATED]

Get posts from a user or page timeline.

Parameters

Name Key Required Type Description
User ID
objectId True string

Unique ID of the user or page whose timeline have to be retrieved.

Max posts
limit integer

Maximum number of posts to be retrieved.

With or without location
with string

Restrict the list of posts to only those with location attached.

Include hidden posts
include_hidden boolean

Whether or not to include any posts that were hidden by the Page.

Fields
fields string

Specify the fields you want returned. Example (id,name,picture).

Returns

List of feed items.

Get user timeline (V2) [DEPRECATED]

Get posts from a user's timeline (V2).

Parameters

Name Key Required Type Description
User ID
userId True string

Unique ID of the user whose timeline have to be retrieved.

Max posts
limit integer

Maximum number of posts to be retrieved.

With or without location
with string

Restrict the list of posts to only those with location attached.

Fields
fields string

Specify the fields you want returned. Example (id,name,picture).

Returns

List of feed items.

Get user timeline [DEPRECATED]

Get posts from a user's timeline.

Parameters

Name Key Required Type Description
User ID
userId True string

Unique ID of the user whose timeline have to be retrieved.

Max posts
limit integer

Maximum number of posts to be retrieved.

With or without location
with string

Restrict the list of posts to only those with location attached.

Fields
fields string

Specify the fields you want returned. Example (id,name,picture).

Returns

List of feed items.

Post to my timeline [DEPRECATED]

Post a status message to the logged in user's timeline.

Parameters

Name Key Required Type Description
Status message
message True string

The main body of the post, otherwise called the status message.

Post link
link uri

The URL of a link to attach to the post.

Link image
picture uri

Determines the preview image associated with the link.

Link name
name string

Overwrites the title of the link preview.

Link caption
caption string

Overwrites the caption under the title in the link preview.

Link description
description string

Overwrites the description in the link preview.

Post location
place string

Page ID of a location associated with this post.

Tagged users
tags string

Comma-separated list of user IDs of people tagged in this post.

Privacy settings description
description string

Text that describes the privacy settings, as they would appear in Facebook.

Privacy value
value True string

The value of the privacy setting.

Allowed users
allow string

When value is CUSTOM, this is a comma-separated list of user IDs and friend list IDs that can see the post.

Denied users
deny string

When value is CUSTOM, this is a comma-separated list of user IDs and friend list IDs that cannot see the post.

Denied friends
friends string

When value is CUSTOM, this indicates which group of friends can see the post.

Thumbnail picture ID
object_attachment string

Facebook ID for an existing picture in the person's photo albums to use as the thumbnail image.

Returns

Details of the item posted to the feed.

Posted Item
PostFeedResponse

Post to page (V2) [DEPRECATED]

Post a message to a Facebook Page as the logged in user (V2).

Parameters

Name Key Required Type Description
Page ID
pageId True string

Unique ID of the page to post to.

Status message
message True string

The main body of the post, otherwise called the status message.

Post link
link uri

The URL of a link to attach to the post.

Link image
picture uri

Determines the preview image associated with the link.

Link name
name string

Overwrites the title of the link preview.

Link caption
caption string

Overwrites the caption under the title in the link preview.

Link description
description string

Overwrites the description in the link preview.

Action link name
name string

The name or label of the action link.

Action link
link string

The URL of the action link itself.

Post location
place string

Page ID of a location associated with this post

Tag users
tags string

Comma-separated list of user IDs of people tagged in this post.

Thumbnail picture ID
object_attachment string

Facebook ID for an existing picture in the person's photo albums to use as the thumbnail image.

Country code
Targetted countries string
Location key
key string

Target location item's key.

Locale code
Targetted locales integer
Country code
Targetted countries string
Location key
key string

Target location item's key.

Minimum age
age_min integer

Must be 13 or higher.

Maximum age
age_max integer

Maximum Age.

Gender code. Use 1 for male and 2 for female.
Targetted genders integer
Relationship status. Use 1 for single, 2 for 'in a relationship', 3 for married, and 4 for engaged.
Targetted relationship statuses integer
Interest code. Use 1 to indicate male, 2 indicates female.
Targetted interests integer
Graduation year
Targetted college graduation year integer
Education status code. Use 1 for high school, 2 for undergraduate, and 3 for alum (or localized equivalents).
Targetted education statuses integer
Locale code
Targetted locales integer
Publish post.
published boolean

Whether a story is shown about this newly published object.

Schedule publish time
scheduled_publish_time date-time

Time when this post should go live, this can be any date between ten minutes and six months from the time of the API call.

Back date time.
backdated_time date-time

Specifies a time in the past to back-date this post to.

Backdated time display format.
backdated_time_granularity string

Controls the display of how a backdated post appears.

Attachment link
link string

The URL of a link to attach to the post.

Link picture
picture uri

Determines the preview image associated with the link (1:1 aspect ratio and a minimum of 458 x 458 px for best display).

Image hash
image_hash string

Hash of a preview image associated with the link from your ad image library (1:1 aspect ratio and a minimum of 458 x 458 px for best display).

Link name
name string

The title of the link preview.

Link description
description string

Used to show either a price, discount or website domain.

Multi-share end card
multi_share_end_card boolean

If set to false, does not display the end card of a carousel link post when child_attachments is used.

Returns

Details of the item posted to the feed.

Posted Item
PostFeedResponse

Post to page [DEPRECATED]

Post a message to a Facebook Page as the logged in user.

Parameters

Name Key Required Type Description
Page ID
objectId True string

Unique ID of the page to post to.

Status message
message True string

The main body of the post, otherwise called the status message.

Post link
link uri

The URL of a link to attach to the post.

Link image
picture uri

Determines the preview image associated with the link.

Link name
name string

Overwrites the title of the link preview.

Link caption
caption string

Overwrites the caption under the title in the link preview.

Link description
description string

Overwrites the description in the link preview.

Action link name
name string

The name or label of the action link.

Action link
link string

The URL of the action link itself.

Post location
place string

Page ID of a location associated with this post

Tag users
tags string

Comma-separated list of user IDs of people tagged in this post.

Thumbnail picture ID
object_attachment string

Facebook ID for an existing picture in the person's photo albums to use as the thumbnail image.

Country code
Targetted countries string
Locale code
Targetted locales integer
Region code
Targetted regions integer
City code
Excluded cities integer
Country code
Targetted countries string
Region code
Targetted regions integer
City code
Excluded cities integer
Minimum age
age_min integer

Must be 13 or higher.

Maximum age
age_max integer

Maximum Age.

Gender code. Use 1 for male and 2 for female.
Targetted genders integer
Relationship status. Use 1 for single, 2 for 'in a relationship', 3 for married, and 4 for engaged.
Targetted relationship statuses integer
Interest code. Use 1 to indicate male, 2 indicates female.
Targetted interests integer
Graduation year
Targetted college graduation year integer
Education status code. Use 1 for high school, 2 for undergraduate, and 3 for alum (or localized equivalents).
Targetted education statuses integer
Locale code
Targetted locales integer
Publish post.
published boolean

Whether a story is shown about this newly published object.

Schedule publish time
scheduled_publish_time date-time

Time when this post should go live, this can be any date between ten minutes and six months from the time of the API call.

Back date time.
backdated_time date-time

Specifies a time in the past to back-date this post to.

Backdated time display format.
backdated_time_granularity string

Controls the display of how a backdated post appears.

Attachment link
link string

The URL of a link to attach to the post.

Link picture
picture uri

Determines the preview image associated with the link (1:1 aspect ratio and a minimum of 458 x 458 px for best display).

Image hash
image_hash string

Hash of a preview image associated with the link from your ad image library (1:1 aspect ratio and a minimum of 458 x 458 px for best display).

Link name
name string

The title of the link preview.

Link description
description string

Used to show either a price, discount or website domain.

Multi-share end card
multi_share_end_card boolean

If set to false, does not display the end card of a carousel link post when child_attachments is used.

Returns

Details of the item posted to the feed.

Posted Item
PostFeedResponse

Triggers

When there is a new post on my timeline [DEPRECATED]

Triggers a new flow when there is a new post on the logged in user's timeline. The ability of our service to detect a post must pass several privacy checks including a person's privacy settings on Facebook. Therefore, it is possible for this trigger to not activate for all posts.

When there is a new post on my timeline [DEPRECATED]

Triggers a new flow when there is a new post on the logged in user's timeline. The ability of our service to detect a post must pass several privacy checks including a person's privacy settings on Facebook. Therefore, it is possible for this trigger to not activate for all posts.

Returns

List of newly created posts.

Timeline Feed
TriggerFeedResponse

Definitions

GetFeedResponse

List of feed items.

Name Path Type Description
Response Data
data array of PostItem

TriggerFeedResponse

List of newly created posts.

Name Path Type Description
Response Data
data array of TriggerItem

PostItem

An individual entry in a profile's feed. The profile could be a user, page, app, or group.

Name Path Type Description
Post ID
id string

Unique ID of the post.

Admin Creators
admin_creator array of AdminItem

Unique ID of admin who created the post. Applies to pages only.

Link caption
caption string

The caption of a link in the post (appears beneath the name).

Created Date-Time
created_time date-time

The time the post was initially published. For a post about a life event, this will be the date and time of the life event.

Link Description
description string

A description of a link in the post (appears beneath the caption).

News Feed Target
feed_targeting FeedTargetItem

Object that controls news feed targeting for this post. Anyone in these groups will be more likely to see this post, others will be less likely. Applies to Pages only.

User
from UserItem

Details of a specific Facebook user.

Icon link
icon string

A link to an icon representing the type of this post.

Is hidden?
is_hidden boolean

If this post is marked as hidden (applies to Pages only).

Is published?
is_published boolean

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).

Link url
link uri

The link attached to this post.

Status message
message string

The status message in the post.

Name
name string

The name of the link.

Media ID
object_id string

The ID of any uploaded photo or video attached to the post.

Image url
picture uri

The picture scraped from any link included with the post.

place
place PlaceItem
privacy
privacy PrivacyItem
Post Properties
properties array of PropertyItem

A list of properties for any attached video, for example, the length of the video.

Video source
source uri

A URL to any Flash movie or video file attached to the post.

Status update type
status_type string

Description of the type of a status update.

Story text
story string

Text from stories not intentionally generated by users, such as those generated when two people become friends, or when someone else posts on the person's wall.

targeting
targeting TargetItem
To
to array of ProfileCollection

Profiles mentioned or targeted in this post.

Post type
type string

A string indicating the object type of this post.

Last updated time
updated_time date-time

The time of the last change to this post, or the comments on it.

with_tags
with_tags ProfileCollection
media
media array of uri

TriggerItem

An individual entry in a profile's feed. The profile could be a user, page, app, or group.

Name Path Type Description
Post ID
id string

The post ID.

Created Time
created_time date-time

The time the post was initially published. For a post about a life event, this will be the date and time of the life event.

User
from UserItem

Details of a specific Facebook user.

Status message
message string

The status message in the post.

Post Type
type string

A string indicating the object type of this post.

Image url
picture uri

The picture scraped from any link included with the post.

Link url
link uri

The link attached to this post.

Name
name string

The name of the link.

Link description
description string

A description of a link in the post (appears beneath the caption).

media
media array of uri

AdminItem

Name Path Type Description
User ID
id integer

Unique ID of the admin user.

Admin full name
name string

Name of the admin.

PropertyItem

Name Path Type Description
Property name
name string

The property name.

Property value
text string

The value of the property.

Property link
href uri

Any link associated with the property.

PostFeedResponse

Details of the item posted to the feed.

Name Path Type Description
Post ID
id string

ProfileCollection

Name Path Type Description
data
data array of UserItem

UserItem

Details of a specific Facebook user.

Name Path Type Description
User ID
id string

Unique ID of the user.

First name
first_name string

User first name.

Last name
last_name string

User last name.

Full name
name string

User full name.

Gender
gender string

Gender of the user.

User bio
about string

Body of the user's bio page.

TargetItem

Name Path Type Description
Targetted countries
countries array of string

Values of targeting countries.

Targetted locales
locales array of integer

Targeted locales.

Targetted regions
regions array of integer

Values for targeted regions.

Excluded cities
cities array of integer

Values for excluded cities.

FeedTargetItem

Object that controls news feed targeting for this post. Anyone in these groups will be more likely to see this post, others will be less likely. Applies to Pages only.

Name Path Type Description
Targetted countries
countries array of string

Values of targeting countries.

Targetted regions
regions array of integer

Values for targeted regions.

Excluded cities
cities array of integer

Values for excluded cities.

Minimum age
age_min integer

Must be 13 or higher.

Maximum age
age_max integer

Maximum Age.

Targetted genders
genders array of integer

Target specific genders. 1 targets all male viewers and 2 females. Default is to target both.

Targetted relationship statuses
relationship_statuses array of integer

Array of integers for targeting based on relationship status.

Targetted interests
interested_in array of integer

Indicates targeting based on the 'interested in' field of the user profile.

Targetted college graduation year
college_years array of integer

Array of integers for graduation year from college.

Targetted education statuses
education_statuses array of integer

Array of integers for targeting based on education level.

Targetted locales
locales array of integer

Targeted locales.

PlaceItem

Name Path Type Description
Place ID
id string

Unique ID of the place

Place name
name string

Name of the place

Place rating
overall_rating float

Overall rating of place, on a 5-star scale. 0 means not enough data to get a combined rating.

location
location LocationItem

LocationItem

Name Path Type Description
City name
city string

City of the location.

Country name
country string

Country of the location.

Latitude
latitude float

Latitude of the location.

Located in
located_in string

The parent location if this location is located within another location.

Longitude
longitude float

Longitude of the location.

Location name
name string

Name of the location.

Region name
region string

Name of the location region.

State name
state string

State which the location is in.

Street name
street string

Street which the location is on.

Zipcode
zip string

Location Zip Code.

PrivacyItem

Name Path Type Description
Privacy settings description
description string

Text that describes the privacy settings, as they would appear in Facebook.

Privacy value
value string

The value of the privacy setting.

Allowed users
allow string

When value is CUSTOM, this is a comma-separated list of user IDs and friend list IDs that can see the post.

Denied users
deny string

When value is CUSTOM, this is a comma-separated list of user IDs and friend list IDs that cannot see the post.

Denied friends
friends string

When value is CUSTOM, this indicates which group of friends can see the post.