Integration Requirements for Events Lead Sync Program

Warning

Deprecation Notice
The Event 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 202304 (Marketing April 2023) and below has been sunset and the unversioned APIs are going to 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 Events 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 Events Lead Sync integrations only. If you are building an Ads Lead Sync integration, see Ads 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 Organizations that logged in user is an administrator of
LGF-102	Demonstrate ability to read all events (per organization) that have leadgen forms attached
LGF-103	Demonstrate ability to automatically read all fields of a form
LGF-104	Demonstrate ability to create datastore/tables as required for a leadgen form
LGF-105	Demonstrate ability to PULL all leads and store them in the data store.
LGF-106	Demonstrate an E2E test, when a lead flows from event registration on LI all the way to data store.
LGF-107	Demonstrate ability to recover from outages using a time-bound PULL request.
LGF-108	Demonstrate ability to teardown, delete integrations and recreate integrations.
LGF-109	Demonstrate a single field failure does not block the lead syncing
LGF-110	Demonstrate a single lead failure will not break syncing of other leads