From a80575e4db73db635ed280d7bf3752f212b0744b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bart=C5=82omiej=20Krakowski?= Date: Mon, 23 Dec 2019 15:02:01 +0100 Subject: [PATCH 1/3] fix(): Render alerts --- .../catalog/cloud-apps/desk-com/index.md | 5 +- .../sources/catalog/cloud-apps/desk/index.md | 385 +++++++++--------- 2 files changed, 198 insertions(+), 192 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/desk-com/index.md b/src/connections/sources/catalog/cloud-apps/desk-com/index.md index ef4f7029ff..379ae878b9 100644 --- a/src/connections/sources/catalog/cloud-apps/desk-com/index.md +++ b/src/connections/sources/catalog/cloud-apps/desk-com/index.md @@ -2,4 +2,7 @@ title: 'Desk.com Source' hidden: true source-type: object ---- \ No newline at end of file +--- + +> info "" +> If you're a customer who just wants to build a simple script or app against a single workspace, you may want to use [Workspace Access Tokens](/docs/config-api/authentication). diff --git a/src/connections/sources/catalog/cloud-apps/desk/index.md b/src/connections/sources/catalog/cloud-apps/desk/index.md index c80abee377..87e1255c44 100644 --- a/src/connections/sources/catalog/cloud-apps/desk/index.md +++ b/src/connections/sources/catalog/cloud-apps/desk/index.md @@ -1,191 +1,194 @@ ---- -rewrite: true -title: Desk.com Source -source-type: object ---- - -[Desk.com](http://www.desk.com/), previously known as Assistly, is a SaaS help desk and customer support product owned by Salesforce.com and accessible through the cloud. - -Desk.com is specifically implemented to targets small businesses with its features and functions. This tool can help you combining your support data with website activity and product usage data, as well as analyzing it using your favorite business intelligence and SQL querying tools. - -This is an [Object Cloud Source](https://segment.com/docs/connections/sources/#object-cloud-sources) which can export data from its third party tool and import it directly into your Segment warehouse. - -## Getting Started - -### Permissions - -You will need a Desk.com account with administrator privileges. - -### Add a new Desk.com source - -1. From your workspace's `sources` page, click `add source`. -3. Choose Desk.com. -4. Choose a name for your Desk.com source to identify it within your workspace. -![](images/desk_com_image_1.png) - -5. Enter your connection credentials -![](images/desk_com_image_2.png) - -6. Add a warehouse or connect Intercom to an already existing warehouse in your workspace - -## Components - -The Desk.com source is built with a sync component, which means we'll make requests to their API on your behalf on a 3 hour interval to pull the latest data into Segment. In the initial sync, we'll grab all the Desk.com objects (and their corresponding properties) according to the Collections Table below. The objects will be written into a separate schema, corresponding to the source instance's schema name you designated upon creation (ie. `desk_com.cases`). - -Our sync component uses an upsert API, so the data in your warehouse loaded via sync will reflect the latest state of the corresponding resource in Desk.com. For example, if `priority` goes from `2` to `4` between syncs, on its next sync that priority value will be `4`. - -The source syncs and warehouse syncs are independent processes. Source runs pull your data into the Segment Hub, and warehouse runs flush that data to your warehouse. Sources will sync with Segment every 3 hours. Depending on your Warehouses plan, we will push the Source data to your warehouse on the interval associated with your billing plan. - - -## Collections - -| Collection | Type | Description | -| ------ | ------ | ------ | -| `articles` | object | Contains all available articles. For more info, check out the [Desk.com docs](http://dev.desk.com/API/articles/#fields) | -| `brands` | object | Contains all brand objects. For more info, check out the [Desk.com docs](http://dev.desk.com/API/brands/#fields) | -| `cases` | object | Contains all cases. For more info, check out the [Desk.com docs](http://dev.desk.com/API/cases/#fields) | -| `companies` | object | Contains all available companies. For more info, check out the [Desk.com docs](http://dev.desk.com/API/companies/#fields) | -| `customers` | object | For more info, check out the [Desk.com docs](http://dev.desk.com/API/customers/#fields) | -| `users` | object | For more info, check out the [Desk.com docs](http://dev.desk.com/API/users/#fields) | -| `feedbacks` | object | Contains customer feedback objects. For more info, check out the [Desk.com docs](http://dev.desk.com/API/feedbacks/#fields) | - -## Collection Properties - -### Articles - -| Property Name | Description | -| ------ | ------- | -| subject | The subject of the article | -| position | The position of the article as displayed in the support center | -| quickcode | Code used in the agent to quickly add article content to a case | -| keywords | Keywords in the article | -| publish_at | Date the article is to be published | -| created_at | Date the article was created | -| updated_at | Date the article was updated | -| body | The content of the article (HTML formatted) | -| body_email | Email specific content | -| body_email_auto | True/false to use content from body | -| body_chat | Chat specific content | -| body_chat_auto | True/false to use content from body | -| body_web_callback | Chat specific content | -| body_web_callback_auto | True/false to use content from body | -| body_twitter | Twitter specific content | -| body_twitter_auto | True/false to use content from body | -| body_qna | QNA specific content | -| body_qna_auto | True/false to use content from body | -| body_phone | Phone specific content | -| body_phone_auto | True/false to use content from body | -| body_facebook | Facebook specific content | -| body_facebook_auto | True/false to use content from body | -| rating | The percentage of people who found the article helpful | -| rating_count | The number of ratings given to the article | -| rating_score | The number of people who found the article helpful | -| public_url | The publicly accessible URL for this article | -| in_support_center | True/false to display the article in the support center | -| internal_notes | Notes to the agent using the article | -| locale | The ISO language code of the article | -| available_locales | A list of ISO language codes corresponding to all available translations for the article | - -### Brands - -| Property Name | Description | -| ------ | ------- | -| name | Name of the brand | -| created_at | When the brand was created | -| updated_at | When the brand was last updated | - -### Cases - -| Property Name | Description | -| ------ | ------- | -| id | integer identifier for this object -| external_id | unique external identifier to reference this case to an external system -| blurb | Short summary of, or excerpt from, the case | -| subject | Subject of the case | -| priority | Number between 1 and 10, 1 being lowest priority | -| Description | Description or background information -| status | Current state of the case, one of: `new`, `open`, `pending`, `resolved`, `closed`, `deleted` | -| type | Channel of the case, one of: chat, twitter, email, qna, facebook, phone | -| labels | Array of labels associated with this case | -| label_ids | Array of label ids associated with this case | -| language | The case's ISO language code, which returns the site's default language (or nil if not set) unless multi-lingual support is enabled | -| custom_fields | Hash of values for custom fields | -| created_at | When this record was created | -| updated_at | When this record was last updated by any action | -| changed_at | When this case was last updated by a user | -| active_at | When this case was last active | -| received_at | When the most recent message was received | -| locked_until | When the lock on this case will expire | -| first_opened_at | When this case was first opened | -| opened_at | When this case was most recently opened | -| first_resolved_at | When this case was first resolved | -| resolved_at | When this case was most recently resolved | -| suppress_rules | Set to `true` to disable rule processing when creating or updating this case | -| route_status | Current routing status of the case. this field only appears when routing is enabled for the first time. there are four values: `added` when a case is first added to desk. this switches to available after a few seconds. `available` case is not in use and can be routed. `assigned` case is being presented to a specific user to accept. `active` a case is open and in edit mode. doesn't necessarily have to have been routed | - -### Companies - -| Property Name | Description | -| ------ | ------- | -| name | Name of the company | -| domains | Array of top level domain names (ie. desk.com, british.co.uk). Pass an array of domains to replace the set of domains for the company. An empty array will clear all domains from the company | -| created_at | When the company was created | -| updated_at | When the company was last updated | -| custom_fields | Hash of values for custom fields | - -### Customers - -| Property Name | Description | -| ------ | ------- | -| first_name | Customer's first name | -| last_name | Customer's last name | -| company | Customer's company | -| title | Customer's title | -| avatar | Customer's avatar URL - image sourced from Twitter, Facebook or Gravatar. See note on avatar_size param below | -| uid | Customer's Multipass SSO UID | -| external_id | Unique external identifier to reference this customer to an external system | -| background | Any background information for the customer | -| language | Customer's ISO language code, nil unless multi-lingual support is enabled -| locked_until | Time in which the lock on this customer will expire -| created_at | Time when customer was created | -| updated_at | Time when customer was last updated at | -| emails | Array of email objects, each specifying the contact type and value of the email address | -| phone_numbers | Array of phone number objects, each specifying the contact type and value of the phone number | -| addresses | Array of address objects, each specifying the contact type and value of the location | -| custom_fields | Hash of values for custom fields | -| access_private_portal | Whether or not customer can access private portal | -| access_company_cases | Whether or not customer can access company cases | - - -### Users - -| Property Name | Description | -| ------ | ------- | -| name | Name of the user | -| public_name | Public facing name of the user | -| email | User's email | -| email_verified | Indicates if an email address has been verified | -| avatar | User's avatar URL - image sourced from Gravatar. | -| level | User's permission level | -| created_at | When this record was created | -| updated_at | When this record was last updated | -| current_login_at | When this user most recently logged in | -| last_login_at | When this user last logged in | -| available | `true` when user is online with routing enabeld, `false` otherwise | - -### Feedbacks - -| Property Name | Description | -| ------ | ------- | -| rating | Numeric rating left by customer | -| rating_type | Rating type used to generate this feedback, either yes_no or four_star | -| additonal_feedback | An optional additional feedback text field | -| created_at | Date the feedback was created | -| updated_at | Date the feedback was updated | -| user | The user who created this feedback | -| case | The case to which this feedback is assigned | - - -## Adding Destinations - -Currently, Warehouses are the only supported destination for object-cloud sources. +--- +rewrite: true +title: Desk.com Source +source-type: object +--- + +> info "" +> If you're a customer who just wants to build a simple script or app against a single workspace, you may want to use [Workspace Access Tokens](/docs/config-api/authentication). + +[Desk.com](http://www.desk.com/), previously known as Assistly, is a SaaS help desk and customer support product owned by Salesforce.com and accessible through the cloud. + +Desk.com is specifically implemented to targets small businesses with its features and functions. This tool can help you combining your support data with website activity and product usage data, as well as analyzing it using your favorite business intelligence and SQL querying tools. + +This is an [Object Cloud Source](https://segment.com/docs/connections/sources/#object-cloud-sources) which can export data from its third party tool and import it directly into your Segment warehouse. + +## Getting Started + +### Permissions + +You will need a Desk.com account with administrator privileges. + +### Add a new Desk.com source + +1. From your workspace's `sources` page, click `add source`. +3. Choose Desk.com. +4. Choose a name for your Desk.com source to identify it within your workspace. +![](images/desk_com_image_1.png) + +5. Enter your connection credentials +![](images/desk_com_image_2.png) + +6. Add a warehouse or connect Intercom to an already existing warehouse in your workspace + +## Components + +The Desk.com source is built with a sync component, which means we'll make requests to their API on your behalf on a 3 hour interval to pull the latest data into Segment. In the initial sync, we'll grab all the Desk.com objects (and their corresponding properties) according to the Collections Table below. The objects will be written into a separate schema, corresponding to the source instance's schema name you designated upon creation (ie. `desk_com.cases`). + +Our sync component uses an upsert API, so the data in your warehouse loaded via sync will reflect the latest state of the corresponding resource in Desk.com. For example, if `priority` goes from `2` to `4` between syncs, on its next sync that priority value will be `4`. + +The source syncs and warehouse syncs are independent processes. Source runs pull your data into the Segment Hub, and warehouse runs flush that data to your warehouse. Sources will sync with Segment every 3 hours. Depending on your Warehouses plan, we will push the Source data to your warehouse on the interval associated with your billing plan. + + +## Collections + +| Collection | Type | Description | +| ------ | ------ | ------ | +| `articles` | object | Contains all available articles. For more info, check out the [Desk.com docs](http://dev.desk.com/API/articles/#fields) | +| `brands` | object | Contains all brand objects. For more info, check out the [Desk.com docs](http://dev.desk.com/API/brands/#fields) | +| `cases` | object | Contains all cases. For more info, check out the [Desk.com docs](http://dev.desk.com/API/cases/#fields) | +| `companies` | object | Contains all available companies. For more info, check out the [Desk.com docs](http://dev.desk.com/API/companies/#fields) | +| `customers` | object | For more info, check out the [Desk.com docs](http://dev.desk.com/API/customers/#fields) | +| `users` | object | For more info, check out the [Desk.com docs](http://dev.desk.com/API/users/#fields) | +| `feedbacks` | object | Contains customer feedback objects. For more info, check out the [Desk.com docs](http://dev.desk.com/API/feedbacks/#fields) | + +## Collection Properties + +### Articles + +| Property Name | Description | +| ------ | ------- | +| subject | The subject of the article | +| position | The position of the article as displayed in the support center | +| quickcode | Code used in the agent to quickly add article content to a case | +| keywords | Keywords in the article | +| publish_at | Date the article is to be published | +| created_at | Date the article was created | +| updated_at | Date the article was updated | +| body | The content of the article (HTML formatted) | +| body_email | Email specific content | +| body_email_auto | True/false to use content from body | +| body_chat | Chat specific content | +| body_chat_auto | True/false to use content from body | +| body_web_callback | Chat specific content | +| body_web_callback_auto | True/false to use content from body | +| body_twitter | Twitter specific content | +| body_twitter_auto | True/false to use content from body | +| body_qna | QNA specific content | +| body_qna_auto | True/false to use content from body | +| body_phone | Phone specific content | +| body_phone_auto | True/false to use content from body | +| body_facebook | Facebook specific content | +| body_facebook_auto | True/false to use content from body | +| rating | The percentage of people who found the article helpful | +| rating_count | The number of ratings given to the article | +| rating_score | The number of people who found the article helpful | +| public_url | The publicly accessible URL for this article | +| in_support_center | True/false to display the article in the support center | +| internal_notes | Notes to the agent using the article | +| locale | The ISO language code of the article | +| available_locales | A list of ISO language codes corresponding to all available translations for the article | + +### Brands + +| Property Name | Description | +| ------ | ------- | +| name | Name of the brand | +| created_at | When the brand was created | +| updated_at | When the brand was last updated | + +### Cases + +| Property Name | Description | +| ------ | ------- | +| id | integer identifier for this object +| external_id | unique external identifier to reference this case to an external system +| blurb | Short summary of, or excerpt from, the case | +| subject | Subject of the case | +| priority | Number between 1 and 10, 1 being lowest priority | +| Description | Description or background information +| status | Current state of the case, one of: `new`, `open`, `pending`, `resolved`, `closed`, `deleted` | +| type | Channel of the case, one of: chat, twitter, email, qna, facebook, phone | +| labels | Array of labels associated with this case | +| label_ids | Array of label ids associated with this case | +| language | The case's ISO language code, which returns the site's default language (or nil if not set) unless multi-lingual support is enabled | +| custom_fields | Hash of values for custom fields | +| created_at | When this record was created | +| updated_at | When this record was last updated by any action | +| changed_at | When this case was last updated by a user | +| active_at | When this case was last active | +| received_at | When the most recent message was received | +| locked_until | When the lock on this case will expire | +| first_opened_at | When this case was first opened | +| opened_at | When this case was most recently opened | +| first_resolved_at | When this case was first resolved | +| resolved_at | When this case was most recently resolved | +| suppress_rules | Set to `true` to disable rule processing when creating or updating this case | +| route_status | Current routing status of the case. this field only appears when routing is enabled for the first time. there are four values: `added` when a case is first added to desk. this switches to available after a few seconds. `available` case is not in use and can be routed. `assigned` case is being presented to a specific user to accept. `active` a case is open and in edit mode. doesn't necessarily have to have been routed | + +### Companies + +| Property Name | Description | +| ------ | ------- | +| name | Name of the company | +| domains | Array of top level domain names (ie. desk.com, british.co.uk). Pass an array of domains to replace the set of domains for the company. An empty array will clear all domains from the company | +| created_at | When the company was created | +| updated_at | When the company was last updated | +| custom_fields | Hash of values for custom fields | + +### Customers + +| Property Name | Description | +| ------ | ------- | +| first_name | Customer's first name | +| last_name | Customer's last name | +| company | Customer's company | +| title | Customer's title | +| avatar | Customer's avatar URL - image sourced from Twitter, Facebook or Gravatar. See note on avatar_size param below | +| uid | Customer's Multipass SSO UID | +| external_id | Unique external identifier to reference this customer to an external system | +| background | Any background information for the customer | +| language | Customer's ISO language code, nil unless multi-lingual support is enabled +| locked_until | Time in which the lock on this customer will expire +| created_at | Time when customer was created | +| updated_at | Time when customer was last updated at | +| emails | Array of email objects, each specifying the contact type and value of the email address | +| phone_numbers | Array of phone number objects, each specifying the contact type and value of the phone number | +| addresses | Array of address objects, each specifying the contact type and value of the location | +| custom_fields | Hash of values for custom fields | +| access_private_portal | Whether or not customer can access private portal | +| access_company_cases | Whether or not customer can access company cases | + + +### Users + +| Property Name | Description | +| ------ | ------- | +| name | Name of the user | +| public_name | Public facing name of the user | +| email | User's email | +| email_verified | Indicates if an email address has been verified | +| avatar | User's avatar URL - image sourced from Gravatar. | +| level | User's permission level | +| created_at | When this record was created | +| updated_at | When this record was last updated | +| current_login_at | When this user most recently logged in | +| last_login_at | When this user last logged in | +| available | `true` when user is online with routing enabeld, `false` otherwise | + +### Feedbacks + +| Property Name | Description | +| ------ | ------- | +| rating | Numeric rating left by customer | +| rating_type | Rating type used to generate this feedback, either yes_no or four_star | +| additonal_feedback | An optional additional feedback text field | +| created_at | Date the feedback was created | +| updated_at | Date the feedback was updated | +| user | The user who created this feedback | +| case | The case to which this feedback is assigned | + + +## Adding Destinations + +Currently, Warehouses are the only supported destination for object-cloud sources. From f1b10702a30a1db0f6853805290eb8d2c436edbd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bart=C5=82omiej=20Krakowski?= Date: Mon, 23 Dec 2019 15:03:00 +0100 Subject: [PATCH 2/3] fix(): Remove alerts --- src/connections/sources/catalog/cloud-apps/desk-com/index.md | 3 --- src/connections/sources/catalog/cloud-apps/desk/index.md | 3 --- 2 files changed, 6 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/desk-com/index.md b/src/connections/sources/catalog/cloud-apps/desk-com/index.md index 379ae878b9..ec6976658f 100644 --- a/src/connections/sources/catalog/cloud-apps/desk-com/index.md +++ b/src/connections/sources/catalog/cloud-apps/desk-com/index.md @@ -3,6 +3,3 @@ title: 'Desk.com Source' hidden: true source-type: object --- - -> info "" -> If you're a customer who just wants to build a simple script or app against a single workspace, you may want to use [Workspace Access Tokens](/docs/config-api/authentication). diff --git a/src/connections/sources/catalog/cloud-apps/desk/index.md b/src/connections/sources/catalog/cloud-apps/desk/index.md index 87e1255c44..10df31ba18 100644 --- a/src/connections/sources/catalog/cloud-apps/desk/index.md +++ b/src/connections/sources/catalog/cloud-apps/desk/index.md @@ -4,9 +4,6 @@ title: Desk.com Source source-type: object --- -> info "" -> If you're a customer who just wants to build a simple script or app against a single workspace, you may want to use [Workspace Access Tokens](/docs/config-api/authentication). - [Desk.com](http://www.desk.com/), previously known as Assistly, is a SaaS help desk and customer support product owned by Salesforce.com and accessible through the cloud. Desk.com is specifically implemented to targets small businesses with its features and functions. This tool can help you combining your support data with website activity and product usage data, as well as analyzing it using your favorite business intelligence and SQL querying tools. From accefb9b1c5cfbab593a13c470ab75fdcb3051ca Mon Sep 17 00:00:00 2001 From: sanscontext Date: Tue, 14 Jan 2020 14:31:13 -0800 Subject: [PATCH 3/3] remove crlf --- .../cloud-apps/facebook-lead-ads/index.md | 273 +++++++++--------- 1 file changed, 137 insertions(+), 136 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/facebook-lead-ads/index.md b/src/connections/sources/catalog/cloud-apps/facebook-lead-ads/index.md index e29312b557..2572d2264e 100644 --- a/src/connections/sources/catalog/cloud-apps/facebook-lead-ads/index.md +++ b/src/connections/sources/catalog/cloud-apps/facebook-lead-ads/index.md @@ -1,136 +1,137 @@ ---- -title: Facebook Lead Ads Source -rewrite: true -source-type: event ---- -Facebook Lead Ads help you capture contact information from people who have expressed interest in your product. Without leaving Facebook's interface, your prospects can now share helpful information with you including work email, name, phone number, and more. Learn more about Facebook Lead Ads [here](https://www.facebook.com/business/news/lead-ads-launch).  - -Segment lets you make the most of your leads by automatically sending them to your business tools like CRM and email. Importantly, these destinations allow you to reach out to customers in real-time using your communication platform of choice, whether you've promised them a demo, a newsletter, a piece of content, or a call from a salesperson. [Learn more about how you can use Facebook Lead Ads with Segment.](/sources/facebook-lead-ads) - -This is an [Event Cloud Source](https://segment.com/docs/connections/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but they can also federate the exported data into your other enabled Segment Destinations. - -This source is maintained by Facebook. For any issues with the source, you may [contact their team](mailto:supportemail@email.com). - -_**NOTE:** Facebook Lead Ads is currently in beta and this doc was last updated on January 07, 2019. This means that there may still be some bugs for us to iron out and we're excited to hear your thoughts. If you are interested in joining or have any feedback to help us improve the Facebook Lead Ads Destination and its documentation, and please [let us know](https://segment.com/help/contact)!_ - -## Getting Started - -1. Set up a Facebook Lead Ad campaign if you haven't already. Instructions on how to do so are [here](https://www.facebook.com/business/help/1462876307360828). -2. Search for "Facebook Lead Ads" within the Sources Catalog and confirm by clicking "Connect" -3. Give the source a name. The name is a label used in the Segment interface, and Segment creates a related schema name which you query against in your warehouse. The nickname can be whatever you like, but we recommend sticking to something that reflects the source itself, like Facebook Lead Ads or Facebook Lead Ads Prod.  -4. Click Create And Continue then Connect to OAuth into Facebook. -5. Select which accounts you would like to sync (you may change this selection later). -6. Verify that your leads are now flowing into Segment. You can quickly test this connection by sending a test lead to Segment with Facebook's [Lead Ad testing tool](https://developers.facebook.com/tools/lead-ads-testing). -7. Click on the Debugger to see a live stream of data coming in from Facebook. You should see your leads come in as Identify calls. - -### Permissions -**Setup** -Admin permissions are required for setup. Advertiser or lower permissions will prevent the source from connecting. - -**Use** -Leads Access Permissions are required to retrieve leads generated by Facebook Lead Ads. This is the default permissions for most roles. Learn more about permissions by [following this link](https://www.facebook.com/business/help/1440176552713521). - -## Components - -**Stream** - -Facebook Lead Ads uses our stream Source component to send events to Segment. These events are then available in any destination that accepts server-side events, including your data warehouse. - -## Events - -Below is a table of events that Facebook Lead Ads sends to Segment. These events will show up as tables in your Warehouse, and as regular events in your other destinations. - - - - - - - - - - -
**Event Name****Description**
IdentifyWhen a Facebook user clicks on your Lead Ad and fills out your form, Segment will fire an identify call with the user's Anonymous ID and any other traits from the form.
- -## Event Properties - -The event properties included in the identify calls are dependent on the fields included in your Lead Ads form. When the user submits the form, an identify call is made. From the Segment Debugger, you can look at the raw code from the identify call. - -See the example below: - -``` -{ - "anonymousId":"254875448264245", - "messageId":"fb_leadads-MND7ItD0c2-254875448264245", - "timestamp":"2016-12-08T16:39:58.000Z", - "traits": { -   "adId": 6052204319312, -   "email":"-----------@gmail.com", -   "formId": 225571381194652, -   "First_Name":"------------", -   "Last_Name":"------------", -   "job_title":"warehouse", -   "work_email":"----------@gmail.com" -  }, - "type":"identify", - "writeKey":"-------------------", - "context": { -   "integration": { -     "name":"facebook-lead-ads", -     "version":"0.0.3" -    }, -   "library": { -     "name":"unknown", -     "version":"unknown" -    } -  }, - "integrations": {}, - "receivedAt":"2016-12-08T16:40:05.490Z", - "originalTimestamp":"2016-12-08T16:39:58.000Z" -} -``` - -## Adding Destinations - -Now that your Source is set up, you can connect it with destinations.  - -Only the destinations listed below can be used with Facebook Lead Ads. Facebook only passes an email address as a customer identifier, but not all destinations can use an email address instead of a User ID.   - -Destinations that can be used with the Facebook Lead Ads Source: - -*CRM* -- Salesforce -- Freshsales - -*Email Marketing* -- Mailchimp -- Marketo -- Eloqua -- AutopilotHQ -- Mailjet -- ActiveCampaign -- Seg -- Drip -- Pardot - -*Live Chat* -- Intercom - -*Analytics* -- Hubspot -- Woopra - -*SMS and Push Notifications* -- Iterable - -*Customer Success* -- HelpScout -- Natero -- Zendesk - -*Enrichment* -- Clearbit -- Madkudu - -Log into your downstream tools and check that your events are populating, and contain all of the properties you expect. If all your events and properties are not showing up, refer to the [Destination docs](https://segment.com/docs/connections/destinations/) for troubleshooting. - -If there are any issues with how the events are arriving to Segment, please [contact the Facebook team](https://www.facebook.com/business/resources#). +--- +title: Facebook Lead Ads Source +rewrite: true +source-type: event +--- + +Facebook Lead Ads help you capture contact information from people who have expressed interest in your product. Without leaving Facebook's interface, your prospects can now share helpful information with you including work email, name, phone number, and more. Learn more about Facebook Lead Ads [here](https://www.facebook.com/business/news/lead-ads-launch).  + +Segment lets you make the most of your leads by automatically sending them to your business tools like CRM and email. Importantly, these destinations allow you to reach out to customers in real-time using your communication platform of choice, whether you've promised them a demo, a newsletter, a piece of content, or a call from a salesperson. [Learn more about how you can use Facebook Lead Ads with Segment.](/sources/facebook-lead-ads) + +This is an [Event Cloud Source](https://segment.com/docs/connections/sources/#event-cloud-sources) which can not only export data into your Segment warehouse, but they can also federate the exported data into your other enabled Segment Destinations. + +This source is maintained by Facebook. For any issues with the source, you may [contact their team](mailto:supportemail@email.com). + +_**NOTE:** Facebook Lead Ads is currently in beta and this doc was last updated on January 07, 2019. This means that there may still be some bugs for us to iron out and we're excited to hear your thoughts. If you are interested in joining or have any feedback to help us improve the Facebook Lead Ads Destination and its documentation, and please [let us know](https://segment.com/help/contact)!_ + +## Getting Started + +1. Set up a Facebook Lead Ad campaign if you haven't already. Instructions on how to do so are [here](https://www.facebook.com/business/help/1462876307360828). +2. Search for "Facebook Lead Ads" within the Sources Catalog and confirm by clicking "Connect" +3. Give the source a name. The name is a label used in the Segment interface, and Segment creates a related schema name which you query against in your warehouse. The nickname can be whatever you like, but we recommend sticking to something that reflects the source itself, like Facebook Lead Ads or Facebook Lead Ads Prod.  +4. Click Create And Continue then Connect to OAuth into Facebook. +5. Select which accounts you would like to sync (you may change this selection later). +6. Verify that your leads are now flowing into Segment. You can quickly test this connection by sending a test lead to Segment with Facebook's [Lead Ad testing tool](https://developers.facebook.com/tools/lead-ads-testing). +7. Click on the Debugger to see a live stream of data coming in from Facebook. You should see your leads come in as Identify calls. + +### Permissions +**Setup** +Admin permissions are required for setup. Advertiser or lower permissions will prevent the source from connecting. + +**Use** +Leads Access Permissions are required to retrieve leads generated by Facebook Lead Ads. This is the default permissions for most roles. Learn more about permissions by [following this link](https://www.facebook.com/business/help/1440176552713521). + +## Components + +**Stream** + +Facebook Lead Ads uses our stream Source component to send events to Segment. These events are then available in any destination that accepts server-side events, including your data warehouse. + +## Events + +Below is a table of events that Facebook Lead Ads sends to Segment. These events will show up as tables in your Warehouse, and as regular events in your other destinations. + + + + + + + + + + +
**Event Name****Description**
IdentifyWhen a Facebook user clicks on your Lead Ad and fills out your form, Segment will fire an identify call with the user's Anonymous ID and any other traits from the form.
+ +## Event Properties + +The event properties included in the identify calls are dependent on the fields included in your Lead Ads form. When the user submits the form, an identify call is made. From the Segment Debugger, you can look at the raw code from the identify call. + +See the example below: + +```js +{ + "anonymousId":"254875448264245", + "messageId":"fb_leadads-MND7ItD0c2-254875448264245", + "timestamp":"2016-12-08T16:39:58.000Z", + "traits": { +   "adId": 6052204319312, +   "email":"-----------@gmail.com", +   "formId": 225571381194652, +   "First_Name":"------------", +   "Last_Name":"------------", +   "job_title":"warehouse", +   "work_email":"----------@gmail.com" +  }, + "type":"identify", + "writeKey":"-------------------", + "context": { +   "integration": { +     "name":"facebook-lead-ads", +     "version":"0.0.3" +    }, +   "library": { +     "name":"unknown", +     "version":"unknown" +    } +  }, + "integrations": {}, + "receivedAt":"2016-12-08T16:40:05.490Z", + "originalTimestamp":"2016-12-08T16:39:58.000Z" +} +``` + +## Adding Destinations + +Now that your Source is set up, you can connect it with destinations.  + +Only the destinations listed below can be used with Facebook Lead Ads. Facebook only passes an email address as a customer identifier, but not all destinations can use an email address instead of a User ID.   + +Destinations that can be used with the Facebook Lead Ads Source: + +*CRM* +- Salesforce +- Freshsales + +*Email Marketing* +- Mailchimp +- Marketo +- Eloqua +- AutopilotHQ +- Mailjet +- ActiveCampaign +- Seg +- Drip +- Pardot + +*Live Chat* +- Intercom + +*Analytics* +- Hubspot +- Woopra + +*SMS and Push Notifications* +- Iterable + +*Customer Success* +- HelpScout +- Natero +- Zendesk + +*Enrichment* +- Clearbit +- Madkudu + +Log into your downstream tools and check that your events are populating, and contain all of the properties you expect. If all your events and properties are not showing up, refer to the [Destination docs](https://segment.com/docs/connections/destinations/) for troubleshooting. + +If there are any issues with how the events are arriving to Segment, please [contact the Facebook team](https://www.facebook.com/business/resources#).