Facebook

Discover more about the Facebook connector and how to use it on the Digibee Integration Platform.

The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.

Facebook sends requests to Facebook APIs supported by Facebook4J.

Parameters

Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB).

General tab

Parameter Description Default value Data type

Parameter	Description	Default value	Data type
Dynamic Account	When active, the connector will use the account dynamically. Otherwise, it will use the account statically.	False	Boolean
Account Name `(DB)`	The name of the dynamic account used by the connector. This account must have been previously configured in a Store Account connector in the pipeline for this process to take effect. It is only available if the Dynamic Account parameter is active.	N/A	String
Account	The account used by the connector. It is only available if the Dynamic Account parameter is inactive.	N/A	Account
Method Name `(DB)`	The operation to perform.	N/A	String
Fail On Error	If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the `"success"` property.	False	Boolean

Dynamic Account

When active, the connector will use the account dynamically. Otherwise, it will use the account statically.

False

Boolean

Account Name (DB)

The name of the dynamic account used by the connector. This account must have been previously configured in a Store Account connector in the pipeline for this process to take effect. It is only available if the Dynamic Account parameter is active.

N/A

String

Account

The account used by the connector. It is only available if the Dynamic Account parameter is inactive.

N/A

Account

Method Name (DB)

The operation to perform.

N/A

String

Fail On Error

If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.

False

Boolean

Optional tab

Parameter Description Default value Data type

Parameter	Description	Default value	Data type
Achievement URL `(DB)`	The unique URL of the achievement.	N/A	String
Album Id `(DB)`	The album ID.	N/A	String
App Id `(DB)`	The ID of the Facebook Application.	N/A	String
Checkin Id `(DB)`	The checkin ID.	N/A	String
Client URL `(DB)`	Facebook4J API client URL.	N/A	String
Client Version `(DB)`	Facebook4J client API version.	N/A	String
Comment Id `(DB)`	The comment ID.	N/A	String
Debug Enabled	Enables debug output. Effective only with the embedded logger.	False	Boolean
Description `(DB)`	The description text.	N/A	String
Distance	Distance in meters.	N/A	Integer
Domain Id `(DB)`	The domain ID.	N/A	String
Domain Name `(DB)`	The domain name.	N/A	String
Domain Names `(DB)`	The domain names.	N/A	JSON
Event Id `(DB)`	The event ID.	N/A	String
Friend Id `(DB)`	The friend ID.	N/A	String
Friendlist Id `(DB)`	The friend list ID.	N/A	String
Friendlist Name `(DB)`	The friend list name.	N/A	String
Friend User Id `(DB)`	The friend user ID.	N/A	String
Group Id `(DB)`	The group ID.	N/A	String
Gzip Enabled	Enables Facebook GZIP encoding.	True	Boolean
Http Connection Timeout	HTTP connection timeout in milliseconds.	20000	Integer
Http Default Max Per Route	HTTP maximum connections per route.	2	Integer
Http Max Total Connections	HTTP maximum total connections.	20	Integer
Http Read Timeout	HTTP read timeout in milliseconds.	120000	Integer
Http Retry Count	Number of HTTP retries.	0	Integer
Http Retry Interval Seconds	HTTP retry interval in seconds.	5	Integer
Http Streaming Read Timeout	HTTP streaming read timeout in milliseconds.	40000	Integer
Ids `(DB)`	The IDs of users.	N/A	JSON
In Body `(DB)`	Sets the name of a parameter to be passed in the "In Body" exchange.	N/A	String
Include Read	Enables notifications that the user has already read in addition to unread ones.	False	Boolean
Is Hidden	Indicates whether it is hidden.	False	Boolean
Json Store Enabled	If set to true, raw JSON forms will be stored in DataObjectFactory.	False	Boolean
Link `(DB)`	Link URL.	N/A	String
Link Id `(DB)`	Link ID.	N/A	String
Locale `(DB)`	Desired FQL locale.	N/A	String
Mbean Enabled	If set to true, Facebook4J MBean will be registered.	false	Boolean
Message `(DB)`	The message text.	N/A	String
Message Id `(DB)`	The message ID.	N/A	String
Metric `(DB)`	The metric name.	N/A	String
Milestone Id `(DB)`	The milestone ID.	N/A	String
Name `(DB)`	Test user name, must be of the form ‘first last’.	N/A	String
Note Id `(DB)`	The note ID.	N/A	String
Notification Id `(DB)`	The notification ID.	N/A	String
Object Id `(DB)`	The insight object ID.	N/A	String
Offer Id `(DB)`	The offer ID.	N/A	String
Option Description `(DB)`	The description of the question’s answer option.	N/A	String
Page Id `(DB)`	The page ID.	N/A	String
Permission Name `(DB)`	The permission name.	N/A	String
Permissions `(DB)`	Test user permissions in the format perm1, perm2, etc.	N/A	String
Photo Id `(DB)`	The photo ID.	N/A	String
Picture Id	The picture ID.	N/A	Integer
Picture Id2	The second picture ID.	N/A	Integer
Picture Size	The picture size.	N/A	String
Place Id `(DB)`	The place ID.	N/A	String
Post Id `(DB)`	The post ID.	N/A	String
Pretty Debug Enabled	Prettifies JSON debug output if set to true.	False	Boolean
Queries	FQL queries.	N/A	String
Query `(DB)`	FQL query or search terms for search endpoints.	N/A	String
Question Id `(DB)`	The question ID.	N/A	String
Reading Options `(DB)`	Configures reading using key/value pairs from the map.	N/A	JSON
Rest Base URL `(DB)`	API base URL.	https://graph.facebook.com/	String
Score Value	The numeric score value.	N/A	Integer
Size	The picture size, one of large, normal, small, or square.	N/A	String
Subject `(DB)`	The note of the subject.	N/A	String
Tab Id `(DB)`	The tab ID.	N/A	String
Test User Id `(DB)`	The ID of the test user.	N/A	String
Title `(DB)`	The title text.	N/A	String
To User Id `(DB)`	The ID of the user to tag.	N/A	String
To User Ids `(DB)`	The IDs of the users to tag.	N/A	JSON
User Id `(DB)`	The Facebook user ID.	N/A	String
User Id1 `(DB)`	The ID of user 1.	N/A	String
User Id2 `(DB)`	The ID of user 2.	N/A	String
User Ids `(DB)`	The IDs of users to invite to the event.	N/A	JSON
User Locale `(DB)`	The test user locale.	N/A	String
Use SSL	Enables SSL.	True	Boolean
Video Base URL `(DB)`	Video API base URL.	https://graph-video.facebook.com/	String
Video Id `(DB)`	The video ID.	N/A	String
Http Proxy Host `(DB)`	HTTP proxy server host name.	N/A	String
Http Proxy Password `(DB)`	HTTP proxy server password.	N/A	String
Http Proxy Port	HTTP proxy server port.	N/A	Number
Http Proxy User `(DB)`	HTTP proxy server user name.	N/A	String

Achievement URL (DB)

The unique URL of the achievement.

N/A

String

Album Id (DB)

The album ID.

N/A

String

App Id (DB)

The ID of the Facebook Application.

N/A

String

Checkin Id (DB)

The checkin ID.

N/A

String

Client URL (DB)

Facebook4J API client URL.

N/A

String

Client Version (DB)

Facebook4J client API version.

N/A

String

Comment Id (DB)

The comment ID.

N/A

String

Debug Enabled

Enables debug output. Effective only with the embedded logger.

False

Boolean

Description (DB)

The description text.

N/A

String

Distance

Distance in meters.

N/A

Integer

Domain Id (DB)

The domain ID.

N/A

String

Domain Name (DB)

The domain name.

N/A

String

Domain Names (DB)

The domain names.

N/A

JSON

Event Id (DB)

The event ID.

N/A

String

Friend Id (DB)

The friend ID.

N/A

String

Friendlist Id (DB)

The friend list ID.

N/A

String

Friendlist Name (DB)

The friend list name.

N/A

String

Friend User Id (DB)

The friend user ID.

N/A

String

Group Id (DB)

The group ID.

N/A

String

Gzip Enabled

Enables Facebook GZIP encoding.

True

Boolean

Http Connection Timeout

HTTP connection timeout in milliseconds.

20000

Integer

Http Default Max Per Route

HTTP maximum connections per route.

Integer

Http Max Total Connections

HTTP maximum total connections.

Integer

Http Read Timeout

HTTP read timeout in milliseconds.

120000

Integer

Http Retry Count

Number of HTTP retries.

Integer

Http Retry Interval Seconds

HTTP retry interval in seconds.

Integer

Http Streaming Read Timeout

HTTP streaming read timeout in milliseconds.

40000

Integer

Ids (DB)

The IDs of users.

N/A

JSON

In Body (DB)

Sets the name of a parameter to be passed in the "In Body" exchange.

N/A

String

Include Read

Enables notifications that the user has already read in addition to unread ones.

False

Boolean

Is Hidden

Indicates whether it is hidden.

False

Boolean

Json Store Enabled

If set to true, raw JSON forms will be stored in DataObjectFactory.

False

Boolean

Link (DB)

Link URL.

N/A

String

Link Id (DB)

Link ID.

N/A

String

Locale (DB)

Desired FQL locale.

N/A

String

Mbean Enabled

If set to true, Facebook4J MBean will be registered.

false

Boolean

Message (DB)

The message text.

N/A

String

Message Id (DB)

The message ID.

N/A

String

Metric (DB)

The metric name.

N/A

String

Milestone Id (DB)

The milestone ID.

N/A

String

Name (DB)

Test user name, must be of the form ‘first last’.

N/A

String

Note Id (DB)

The note ID.

N/A

String

Notification Id (DB)

The notification ID.

N/A

String

Object Id (DB)

The insight object ID.

N/A

String

Offer Id (DB)

The offer ID.

N/A

String

Option Description (DB)

The description of the question’s answer option.

N/A

String

Page Id (DB)

The page ID.

N/A

String

Permission Name (DB)

The permission name.

N/A

String

Permissions (DB)

Test user permissions in the format perm1, perm2, etc.

N/A

String

Photo Id (DB)

The photo ID.

N/A

String

Picture Id

The picture ID.

N/A

Integer

Picture Id2

The second picture ID.

N/A

Integer

Picture Size

The picture size.

N/A

String

Place Id (DB)

The place ID.

N/A

String

Post Id (DB)

The post ID.

N/A

String

Pretty Debug Enabled

Prettifies JSON debug output if set to true.

False

Boolean

Queries

FQL queries.

N/A

String

Query (DB)

FQL query or search terms for search endpoints.

N/A

String

Question Id (DB)

The question ID.

N/A

String

Reading Options (DB)

Configures reading using key/value pairs from the map.

N/A

JSON

Rest Base URL (DB)

API base URL.

https://graph.facebook.com/

String

Score Value

The numeric score value.

N/A

Integer

Size

The picture size, one of large, normal, small, or square.

N/A

String

Subject (DB)

The note of the subject.

N/A

String

Tab Id (DB)

The tab ID.

N/A

String

Test User Id (DB)

The ID of the test user.

N/A

String

Title (DB)

The title text.

N/A

String

To User Id (DB)

The ID of the user to tag.

N/A

String

To User Ids (DB)

The IDs of the users to tag.

N/A

JSON

User Id (DB)

The Facebook user ID.

N/A

String

User Id1 (DB)

The ID of user 1.

N/A

String

User Id2 (DB)

The ID of user 2.

N/A

String

User Ids (DB)

The IDs of users to invite to the event.

N/A

JSON

User Locale (DB)

The test user locale.

N/A

String

Use SSL

Enables SSL.

True

Boolean

Video Base URL (DB)

Video API base URL.

https://graph-video.facebook.com/

String

Video Id (DB)

The video ID.

N/A

String

Http Proxy Host (DB)

HTTP proxy server host name.

N/A

String

Http Proxy Password (DB)

HTTP proxy server password.

N/A

String

Http Proxy Port

HTTP proxy server port.

N/A

Number

Http Proxy User (DB)

HTTP proxy server user name.

N/A

String

Headers tab

Parameter Description Default value Data type

Parameter	Description	Default value	Data type
Raw JSON `(DB)`	The raw JSON.	N/A	String

Raw JSON (DB)

The raw JSON.

N/A

String

Documentation tab

Parameter	Description	Default value	Data type
Documentation	Section for documenting any necessary information about the connector configuration and business rules.	N/A	String

Parameter

Description

Default value

Data type

Documentation

Section for documenting any necessary information about the connector configuration and business rules.

N/A

String

PreviousBraintree NextGitHub

Last updated 22 days ago