With External Properties, you can add additional metadata to a webinar, such as fields of a third party system. You can retrieve external properties via Open API or from the External Properties page of a webinar.
Add External Properties
There are two ways of adding external properties: from the External Properties page and by using the Open API.
From External Properties page
Log into My Webinar.net, open the webinar that you need to add the external properties. From the left menu, you can see the External Properties at the bottom.
Note: If you do not see the External Properties menu, it is because this feature is not available in your account. Please contact webinar.net support team.
Open the External Properties page, you will be able to add external properties.
To add an external property, you need to fill in the following fields:
Property Name: Only used for reference internally.
Property Key: Must be unique within a webinar. Recommend to use a unique word or phrase without space. The API key will be the property name returned in the Open API. For example,
myProperty.Property Type: The data type of this property. Support
TextandText List.Property Value: The value of this property. When it is a
Text List, separate each item in a separate line.
There is no limitation on how many properties that you can create.
You will be able to update or delete existing external properties.
Using Open API
Since v2.1.0, you can manage External Properties via the following APIs.
Create Webinar
Copy Webinar
Update Webinar
Get Webinar
API: Create Webinar
In a Create Webinar request, you can add externalProperties to the request payload. Following is an example of this field.
"externalProperties": [
{
"name": "My Test External Property",
"key": "myTestExternalProperty",
"type": "text",
"value": [
"Property Value"
]
}
]
Note: The value is an array even though its type is text.
For more details, checkout the Create Webinar API doc.
API: Copy Webinar
In a Copy Webinar request, you can also add the externalProperties in the payload. Its structure is exactly the same as the Create Webinar API.
For more details, checkout the Copy Webinar API doc.
API: Update Webinar
In a Update Webinar request, you have following options:
Option | What will happen |
Do not pass | The webinar's external properties will not be changed or deleted. |
Pass an empty | The webinar's external properties will be cleaned up. |
Pass not empty | The webinar's existing external properties that not found in the new list will be deleted. The webinar's existing external properties that found in the new list by New external properties will be added to the webinar. |
The externalProperties field structure is exactly the same as the one in the Create Webinar API.
For more details, checkout the Update Webinar API doc.
API: Get Webinar(s)
In the Get Webinar and Get Webinars API, the external properties will be returned with other built-in properties. See an example below.
{
"webinar": {
"id": "6061bdeb37ea2e68c0f21676",
"title": "Demo Webinar",
"webinarKey": "943731392",
"language": "en_US",
"source": "webcam-and-audio",
"latestSchedule": {
"id": "6061bdeb37ea2e68c0f21677",
"type": "live",
"status": "not-started",
"start": "2022-03-10T13:15:00Z",
"end": "2022-03-10T14:15:00Z",
"timeZone": "America/Los_Angeles"
},
"urls": {
"presenter": "https://present.webinar.net/ydlLjlEK28b",
"audience": "https://app.webinar.net/6P05wPMjQNd",
"reporting": "https://reporting.webinar.net/QNenzm5zaP4",
"autoJoin": "https://join.webinar.net/6P05wPMjQNd/launch",
"integration": "https://registration.webinar.net/integration/fb481b09-2c3d-4f8d-aed2-5e87e71ae542/63041bf772857f10eb04a667"
},
"ecdnVendor": "hive-streaming",
"myTestExternalProperty": "Property Value",
"myTestExternalPropertyList": [
"Property Value 1",
"Property Value 2"
]
}
}
The myTestExternalProperty and myTestExternalPropertyList are the external properties.
For more details, checkout the Get Webinar API doc.
Skipped During Copying
External Properties are skipped during copying.
When you use Open API to copy a webinar, you can provide the new value in the Copy Webinar API. Or, you can go to the External Properties page and add from the page directly.
Avoid Property Overwritten
It is recommend to make sure the value of Property API Key or apiKey in the API is not one of the following built-in properties:
idtitlewebinarKeylanguagesourcelatestScheduleurlsecdnVendor
Otherwise, you will overwrite the built-in property in the Get Webinar(s) result.
For further assistance, contact us through chat or send us an email at support@webinar.net.