Integration Requirements for Ads Lead Sync Program
Warning
Deprecation Notice
The Ads Lead Sync APIs have been deprecated and will reach end of life at the end of July, 2024. New integrations should use the new Lead Sync APIs
Warning
Deprecation Notice
The Marketing Version 202310 (Marketing October 2023) and earlier versions (excluding 202306 and 202307) have been sunset. Additionally, the unversioned APIs will be sunset soon. We recommend that you migrate to the versioned APIs as well as migrate to the new Content and Community Management APIs to avoid disruptions. See the Migration page for more details.
If you haven’t yet migrated and have questions, submit a request on the LinkedIn Developer Support Portal.
LinkedIn has a technical sign off process for the Ads LeadGen program. This ensures that our members get the best experience whether using LinkedIn's native UI or a partner product. The technical review and sign off also ensures that there are no gaps in integrations and that partner products keep up with the latest features and updates released by LinkedIn.
As an API partner, please go through the requirements listed below. These are the capabilities that an integrating partner is expected to build in their product. We request you to plan and incorporate these features early in your design. When you are nearing completion, you must initiate a Technical Sign Off request by contacting your LinkedIn POC on the Business Development team.
A Demo will be scheduled during which you will be asked to showcase all your product capabilities. During this evaluation, LinkedIn may suggest modifications which will need to be completed for the sign off. If all criteria are met (as per the envisioned scope), the technical sign-off is awarded.
This page documents the requirements for Ads Lead Sync integrations only. If you are building an Events Lead Sync integration, see Events Lead Sync Requirements.
Note
You can begin sharing your product with your Beta customers only after receiving the sign off.
Requirements
| Rule | API capabilities to be demonstrated in Demo |
|---|---|
| Basics | |
| LGF-001 | Demonstrate OAuth 2.0 integration, with right scopes, consent screen |
| LGF-002 | Demonstrate ability to periodically verify that an access token is valid (heartbeat /me) |
| LGF-003 | Demonstrate ability to detect access token expiry |
| LGF-004 | Demonstrate ability to retrigger OAuth Flow incase token has expired or been invalidated |
| LGF-005 | Demonstrate ability to use refresh tokens to mint new access tokens. |
| LGF-006 | Demonstrate ability to detect refresh token expiry and retrigger OAuth Flow |
| LGF-007 | Demonstrate ability to check user access and permissions to start receiving leads |
| Core | |
| LGF-101 | Demonstrate ability to retrieve all Sponsored Accounts with status for the logged in user |
| LGF-102 | Demonstrate ability to read all adForms available per sponsored account |
| LGF-103 | Demonstrate ability to automatically read all predefined fields of a form |
| LGF-104 | Demonstrate ability to read all custom questions (and options) of a form |
| LGF-105 | Demonstrate ability to read all Hidden Fields of a form |
| LGF-106 | Demonstrate ability to read all Consent texts of a form |
| LGF-107 | Demonstrate ability to create datastore/tables as required for a leadsync form |
| LGF-108 | Demonstrate ability to fetch all leads and store them in the data store. |
| LGF-109 | Demonstrate an end-to-end test, when a lead flows from Campaign Manager UI all the way to data store. |
| LGF-110 | Demonstrate ability to teardown/delete integration |
| LGF-111 | Demonstrate a single field failure does not block the lead syncing |
| LGF-112 | Demonstrate a single lead failure will not break syncing of other leads |
| LGF-113 | Demonstrate all mappings are based on pre-defined field values |
| LGF-114 | [optional] Demonstrate ability to use metadata fields while syncing in addition to the form fields (Form id, campaign id, account id, creative id, campaign name, account name, form name etc.) |
| Push implementation (best practice with pull backup) | |
| LGF-201 | Demonstrate ability to recover from outages, missed PUSH notifications. |
| LGF-202 | Demonstrate ability to create/register and update webhooks |
| Advanced Push implementation - nice to have but not required | |
| LGF-203 | Demonstrate ability to register and listen for webhooks for specific Campaigns and Creatives |
| LGF-204 | Demonstrate ability to read all adForms available per Campaign and/or Creative |
| Pull implementation | |
| LGF-301 | Demonstrate ability to recover from outages using a time-bound PULL request to get missed leads |
| LGF-302 | Demonstrate ability to re-pull forms periodically |
| Advanced Pull implementation - nice to have but not required | |
| LGF-303 | Demonstrate ability to configure the intervals between PULL requests. |