# Facebook

{% hint style="info" %}
The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.
{% endhint %}

**Facebook** sends requests to Facebook APIs supported by Facebook4J.

## **Parameters**

Take a look at the configuration options for the connector. Parameters supported by [Double Braces expressions](https://docs.digibee.com/documentation/connectors-and-triggers/double-braces/overview) are marked with `(DB)`.

### **General tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Dynamic Account</strong></td><td>When active, the connector will use the account dynamically. Otherwise, it will use the account statically.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Account Name</strong> <code>(DB)</code></td><td>The name of the dynamic account used by the connector. This account must have been previously configured in a <a href="../tools/store-account"><strong>Store Account</strong></a> connector in the pipeline for this process to take effect. It is only available if the <strong>Dynamic Account</strong> parameter is active.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Account</strong></td><td>The account used by the connector. It is only available if the <strong>Dynamic Account</strong> parameter is inactive.</td><td>N/A</td><td>Account</td></tr><tr><td><strong>Method Name</strong> <code>(DB)</code></td><td>The operation to perform.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Fail On Error</strong></td><td>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 <code>"success"</code> property.</td><td>False</td><td>Boolean</td></tr></tbody></table>

### **Optional tab**

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

### **Headers tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Raw JSON</strong> <code>(DB)</code></td><td>The raw JSON.</td><td>N/A</td><td>String</td></tr></tbody></table>

### **Documentation tab**

<table data-full-width="true"><thead><tr><th>Parameter</th><th>Description</th><th>Default value</th><th>Data type</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td>Section for documenting any necessary information about the connector configuration and business rules.</td><td>N/A</td><td>String</td></tr></tbody></table>
