Share via

LinkedIn Events

  • Article

The identity of the resourceName is events . Currently, this resource captures all LinkedIn events created by regulated members. This also includes LinkedIn events created by a regulated member on behalf of a Company Page. The methods available are: CREATE.

LinkedIn Event activity schema

Following is the schema for the activity field of the Compliance Events created for LinkedIn Events. This activity is processed and additional contextual information is added and stored as the processedActivity field in the compliance event.

Field Description Format
id Unique identifier of the event long
name The name of the event, as input by the user MultiLocaleRichText
vanityName Vanity name (unique across events) for the event that helps with easy identification. string
description The description of the event, as input by the user. This field will not be present when event description is not provided by the organizer. MultiLocaleRichText
organizer Entity responsible for organizing this event - possible urn types: urn:li:person:{personID} (Event created by a regulated member), urn:li:organization:{organizationID} (Event created on behalf of a company page). string
backgroundImage DigitalMediaAssetUrn of the background image associated with this event string
timeRangeV2.startAt The start time of the event. long
timeRangeV2.endsAt The end time of the event. The field will not be present if the organizer hasn't entered an end time during event creation long
externalUrl Url external to LinkedIn containing event information. string
settings Container for various event settings. EventSettings
venueDetails The additional details about the event venue, on top of the address field, like room name, floor number etc. as input by the user. MultiLocaleRichText
address The physical address of the event (i.e. where the event is taking place). This field will not be present when address is not provided by the organizer. Address
eventTimezone The event's timezone in IANA Time Zone database format. string
hashtags Hashtag urns used to generate event feed, specified by event organizer. List[string]
closed Flag to indicate if this is a closed event meaning the attendees are required to register before joining the event boolean

EventSettings Schema

Field Description Format
entryCriteria Entry criteria member needs to satisfy to be able to attend the event. Possible values:
  • PUBLIC: This event is open to all members.
  • GATED: A member needs to raise a request to attend the event.
 Enum
discoveryMode Mode in which the event can be discovered on LinkedIn. Possible values:
  • LISTED: Event is discoverable through search/relevance/recommendation channels.
  • URL_ONLY: Event can only be discovered via URL.
 Enum
attendanceMode Mode in which the attendees can attend an event. Possible values:
  • IN_PERSON: The event is an offline only event with physical location associated to it and can only be attended in person.
  • VIRTUAL: The event is an online only event, which has no physical location associated to it. It can only be attended virtually using steaming Url.
  • IN_PERSON_OR_VIRTUAL: The event has a physical location to attend in person and also has url for attending virtually.
 Enum

Sample activity - LinkedIn event created by a regulated user

{
    "owner": "urn:li:person:<personID>",
    "resourceId": "7022126346663247872",
    "activity": {...},
    "method": "CREATE",
    "resourceName": "events",
    "resourceUri": "/events/7022126346663247872",
    "actor": "urn:li:person:<personID>",
    "activityId": "e1f1e63b-2840-4c91-bb44-937c017fa186",
    "activityStatus": "SUCCESS",
    "processedActivity": {
        "timeRangeV2": {
            "startsAt": 1674210600000
        },
        "vanityName": "event-vanity-name",
        "settings": {
            "entryCriteria": "PUBLIC",
            "attendanceMode": "VIRTUAL",
            "discoveryMode": "LISTED",
        },
        "externalUrl": "https://companyName.com/eventLink",
        "backgroundImage~": {
            "paging": {
                "start": 0,
                "count": 10,
                "links": []
            },
            "elements": [
                {
                    "artifact": "urn:li:digitalmediaMediaArtifact:(urn:li:digitalmediaAsset:D4D1EAQH7emFRT6ZOpw,urn:li:digitalmediaMediaArtifactClass:event-background-image-crop_720_1280)",
                    "pluggableServiceFactory": "com.linkedin.vector.assetmanager.logic.pluggableservice.uploaddownloadservice.UploadDownloadServiceFactory",
                    "data": {...
                    },
                    "authorizationMethod": "PUBLIC",
                    "identifiers": [
                        {
                            "identifier": "https://media.licdn.com/dms/image/D4D1EAQH7emFRT6ZOpw/event-background-image-crop_720_1280/0/1674205384525?e=2147483647&v=beta&t=OEFOAYMWj7nRAZtTjp5rAeyYMRioTE1OItkj1mU-rTY",
                            "file": "urn:li:digitalmediaFile:(urn:li:digitalmediaAsset:D4D1EAQH7emFRT6ZOpw,urn:li:digitalmediaArtifactClass:event-background-image-crop_720_1280,0)",
                            "size": 64326,
                            "index": 0,
                            "mediaType": "image/png",
                            "identifierType": "EXTERNAL_URL",
                            "identifierExpiresInSeconds": 1674810216
                        }
                    ]
                }
            ]
        },
        "organizer~": {
            "localizedLastName": "Test",
            "firstName": {
                "localized": {
                    "en_US": "Siddartha"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "profilePicture": {
                "displayImage": "urn:li:digitalmediaAsset:C4D03AQEA6HWqv-N3Yw",
                "displayImage~": {...
                }
            },
            "lastName": {
                "localized": {
                    "en_US": "Test"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "vanityName": "testVanityName",
            "localizedHeadline": " LinkedIn Headline",
            "headline": {...
            },
            "localizedFirstName": "Siddartha"
        },
        "organizer": "urn:li:person:A3iH9CIw-n",
        "backgroundImage": "urn:li:digitalmediaAsset:D4D1EAQH7emFRT6ZOpw",
        "name": {
            "localized": {
                "en_US": "https://company.name/eventLink"
            },
            "preferredLocale": {
                "country": "US",
                "language": "en"
            }
        },
        "description": {
            "localized": {
                "en_US": {
                    "rawText": "Description Lorem Ipsum"
                }
            },
            "preferredLocale": {
                "country": "US",
                "language": "en"
            }
        },
        "id": <eventID>,
        "eventTimezone": "Asia/Kolkata"
    }
}

Sample activity - LinkedIn event created on behalf of a company page

{
    "owner": "urn:li:person:<personID>",
    "resourceId": "7022128501281468416",
    "activity": {...},
    "method": "CREATE",
    "configVersion": 5,
    "parentSiblingActivities": [],
    "resourceName": "events",
    "resourceUri": "/events/7022128501281468416",
    "actor": "urn:li:person:<personID>",
    "activityId": "2851c9c3-0fdf-4cfc-90e3-c14de02f7065",
    "activityStatus": "SUCCESS",
    "processedActivity": {
        "timeRangeV2": {
            "startsAt": 1674210600000
        },
        "vanityName": "eventbythecompany7022128501281468416",
        "settings": {
            "entryCriteria": "PUBLIC",
            "attendanceMode": "VIRTUAL",
            "discoveryMode": "LISTED"
        },
        "externalUrl": "https://companyName.com/eventLink",
        "backgroundImage~": {
            "paging": {
                "start": 0,
                "count": 10,
                "links": []
            },
            "elements": [
                {
                    "artifact": "urn:li:digitalmediaMediaArtifact:(urn:li:digitalmediaAsset:<assedID>,urn:li:digitalmediaMediaArtifactClass:event-background-image-crop_720_1280)",
                    "pluggableServiceFactory": "com.linkedin.vector.assetmanager.logic.pluggableservice.uploaddownloadservice.UploadDownloadServiceFactory",
                    "data": {},
                    "authorizationMethod": "PUBLIC",
                    "identifiers": [
                        {
                            "identifier": "https://media.licdn.com/dms/image/D4wD1EAQHivBOEijWxpA/event-background-image-crop_720_1280/0/1674205898339?e=2147483647&v=beta&t=kZ26MHfSqF8kc3Rnwg8soZYxm9-XVZwcy2uvhroFkCA",
                            "file": "urn:li:digitalmediaFile:(urn:li:digitalmediaAsset:<assedID>,urn:li:digitalmediaArtifactClass:event-background-image-crop_720_1280,0)",
                            "size": 64326,
                            "index": 0,
                            "mediaType": "image/png",
                            "identifierType": "EXTERNAL_URL",
                            "identifierExpiresInSeconds": 1674810729
                        }
                    ]
                }
            ]
        },
        "organizer~": {
            "name": {
                "localized": {
                    "en_US": "TestCompany"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "localizedName": "TestCompany"
        },
        "organizer": "urn:li:organization:<orgID>",
        "backgroundImage": "urn:li:digitalmediaAsset:<assedID>",
        "name": {
            "localized": {
                "en_US": "Event by the company"
            },
            "preferredLocale": {
                "country": "US",
                "language": "en"
            }
        },
        "description": {
            "localized": {
                "en_US": {
                    "rawText": "Description Lorem Ipsum"
                }
            },
            "preferredLocale": {
                "country": "US",
                "language": "en"
            }
        },
        "id": 7022128501281468416,
        "eventTimezone": "Asia/Kolkata"
    }
}

Sample activity - In-Person LinkedIn event created by a regulated user

{
    "owner": "urn:li:person:<personID>",
    "resourceId": "7022128906526699520",
    "activity": {...},
    "method": "CREATE",
    "resourceName": "events",
    "resourceUri": "/events/7022128906526699520",
    "actor": "urn:li:person:<personID>",
    "activityId": "cb179af2-daf5-47f7-a2be-0285b3c13298",
    "activityStatus": "SUCCESS",
    "processedActivity": {
        "vanityName": "inpersonevent7022128906526699520",
        "timeRangeV2": {
            "endsAt": 1674387000000,
            "startsAt": 1674297000000
        },
        "settings": {
            "entryCriteria": "PUBLIC",
            "attendanceMode": "IN_PERSON",
            "discoveryMode": "LISTED"
        },
        "externalUrl": "https://companyName.com/eventLink",
        "address": {
            "country": "IN",
            "geographicArea": "State",
            "line2": "demo line2",
            "city": "demoCity",
            "line1": "demo line1",
            "postalCode": "000000"
        },
        "organizer~": {
            "name": {
                "localized": {
                    "en_US": "TestCompany"
                },
                "preferredLocale": {
                    "country": "US",
                    "language": "en"
                }
            },
            "localizedName": "TestCompany"
        },
        "organizer": "urn:li:organization:77346936",
        "name": {
            "localized": {
                "en_US": "In Person Event"
            },
            "preferredLocale": {
                "country": "US",
                "language": "en"
            }
        },
        "venueDetails": {
            "localized": {
                "en_US": {
                    "rawText": "7th Floor"
                }
            },
            "preferredLocale": {
                "country": "US",
                "language": "en"
            }
        },
        "description": {
            "localized": {
                "en_US": {
                    "rawText": "Description Lorem Ipsum"
                }
            },
            "preferredLocale": {...}
        },
        "id": 7022128906526699520,
        "eventTimezone": "Asia/Kolkata"
    }
}