LinkedIn Connector

[plamarque]

Rationale

LinkedIn is a major platform for all work organizations to meet workers. Many Web3 projects and Web2 brands and companies use it to reach an audience and promote their organization, products, or services. Meeds can help design fair and equitable incentives for contributors who support their organizations on LinkedIn.

1. Functional Requirements

Contributor

• As a contributor, I can connect my LinkedIn account to my Hub account from my User Settings > Other Apps
• As a contributor, my connected LinkedIn profile is displayed on my user profile
• As a contributor, I can only participate in LinkedIn actions when my LinkedIn account is connected to my Meeds account.
  • If my LinkedIn account is not connected, then a call to action button is displayed on the action instead of the Contribute button :
  • When clicking on it, the oAuth window opens so the user can connect to his account.
  • Once done, the detail drawer is updated, and I can participate

Program Owner

Like

• As a program owner, I can create automated actions for the "LinkedIn" application to track when users Like a given post
• When adding / editing or displaying a Like action, I can see a preview of the LinkedIn post as an embed (iframe) within the drawer.

Comment

• As a program owner, I can create automated actions for the "LinkedIn" application to track when users Comment on a given post
• When adding / editing or displaying a Comment action, I can see a preview of the LinkedIn post as an embed (iframe) within the drawer.

Repost

• As a program owner, I can create automated actions for the "LinkedIn" application to track when Repost a given post
• When adding / editing or displaying a Repost action, I can see a preview of the LinkedIn post as an embed (iframe) within the drawer.

Mention

• As a program owner, I can create automated actions for the "LinkedIn" application to track when @mention (aka tag) a given LinkedIn account.

Follow

• As a program owner, I can create automated actions for "LinkedIn" application to track when users Follow a company page
• Companies available to select are from the list configured by the Hub administrator

Work For

• As a program owner, I can create automated actions for the "LinkedIn" application to track when a user adds a work experience on a given company
• Companies available to select from list configured by the Hub administrator

Hub Administrator

• As a Hub administrator, I should configure the LinkedIn connector to let users connect their LinkedIn account to their Meeds profile

• As a Hub administrator, I may configure the LinkedIn connector to use my oAuth Application credentials (Client ID and Client Secret)

• As a Hub administrator, I may select companies to watch on LinkedIn

• As a Hub administrator, I may enable/disable what events will be able to program owners when creating their LinkedIn actions

Event Name	Description	Contribution Owner	Cancel Event
Like	Like or any reaction to a given post	user who reacted	Unlike
Comment	Comment a given post	user who commented	Comment is removed
Repost	Respoted a given post	user who reposted	Repost is removed
Mention	@ mention a given account	user who mentioned	Mention is removed
Follow Company	Follow a company page	user who followed	Unfollow
Work for...	User declares experience as working for a given company	user who added the experience	experience removed

Impacts

Gamification

Notifications

Analytics

• Track actions triggered

Unified Search

2. Technical Requirements

Expected Volume & Performance

Security

The oAuth tokens SHOULD NOT be stored in the Meeds database; they should only be used to validate user accounts on external providers.

LinkedIn's API key (secret) to transmit triggered events into the Meeds server MUST be generated by the hub administrator using a specific UI in the Gamification administration UI inside LinkedIn connector settings. This Meeds API Key has to be encrypted using CodecInitializer before being stored in the database.

The Hub administrator MUST provide LinkedIn oAuth Client and Secret keys in a dedicated UI. Those oAuth Keys must be encrypted using CodecInitializer before being stored in the database. These keys will be used to validate the oAuth token provided by the user from the Meeds Server to the LinkedIn Server.

Extensibility

Configurability

Upgradability

Existing Features

Feature Flags

Property Name	Default Value	Target Audience	Functional Behaviour

Other Non-Functional Requirements

3. Impacts

Documentation

• UserGuide > Connecting your Apps > LinkedIn
• Admin Guide > Integrations > Linkedin
• Admin Guide > Designing Incentives > Growing your audience on LinkedIn

Training

4. Software Architecture

Security

Access

• GUI
• API

Services & processing

• Ex: Scheduled Jobs

Data and persistence

• Macro data model
• Persistence layer
• Use of caches

  Clustering

Multitenancy

Integrations

The connector will use Community Management APIs

Migration strategy

5. Annexes

• Reasoning that explains the technical choices
• Impacts
• References

[plamarque]

@srenault-meeds @margondicco please check for functional requirements. It's similar to Twitter connector.

[srenault-meeds]

Thanks.

Feedbacks/questions:

As a Hub administrator, I can setup the LinkedIn administrator with the oAuth credentials of my organization

• Do you mean "setup the LinkedIn account"?

As a program owner, I can specify the minimum number of connections a contributor's LinkedIn account should have to earn with the LinkedIn actions

• I know there is a difference between connections and followers. Do we only capture the connections number or also the followers? Regarding LinkedIn events, does this difference exist?

[plamarque]

Do you mean "setup the LinkedIn account"?

I meant the connector. fixed.

Do we only capture the connections number or also the followers?

connections only (followers does not seem available in the APIs so far)

[plamarque]

@srenault-meeds @margondicco mockups added

[srenault-meeds]

Ok for me. Please make sure the linkedin icon color below is the official blue of LinkedIn: #2867b2

[plamarque]

Ok for me. Please make sure the linkedin icon color below is the official blue of LinkedIn: #2867b2

done

[srenault-meeds]

Ok for me. I let @margondicco check it as well