Below is the JetWebinar API REST Schema.
Should you have any other questions, please feel free to submit a ticket above.
Protocol
HTTP Endpoint:
https://<account_id>.jetwebinar.com/dev-api/v1/<resource paths>
Request Headers:
Content-type: application/json
Response Headers:
Content-type: application/json
Authorization
All request headers must contain a Base64-encoded value pair of your JetWebinar’s account ID and private API key, separated by a colon (i.e. jetwebinar:9NeXjVqIHHWZE5EKJNwy20WUAbCRp8x2).
API Key is available from the JetWebinar dashboard under ‘Settings’.
Example:
Authorization:
Basic amV0d2ViaW5hcjo5TmVYalZxSUhIV1pFNUVLSk53eTIwV1VBYkNScDh4Mg==
Resources
/events
|
Path & Method |
Request Parameters |
Success Response Data |
|
/ POST Schedule and create an event |
Required: eventType<string>: live|simulated eventTitle<string> eventTimezone<string>: *see list below Only if live: eventTime<string>: YYYY-MM-DD HH:MM:SS Only if simulated: simulatedRun<string>: once | hourly | recurring Only if simulated once: simulatedTime<string>: YYYY-MM-DD HH:MM:SS Only if simulated recurring: simulatedRecurring<array>: [ { day<string>: Monday...Sunday time<string>: HH:MM } ] Optional: eventUrl<string> registrationHeadline<string> registrationDescription<string> registrationTheme<string>: *see options below |
id<int> eventUrl<string> registrationUrl<string> |
|
/{eventId} PUT Edit event schedule (excluding event type) |
Only if live: eventTime<string>: YYYY-MM-DD HH:MM:SS Only if simulated: simulatedRun<string>: once | hourly | recurring Only if simulated once: simulatedTime<string>: YYYY-MM-DD HH:MM:SS Only if simulated recurring: simulatedRecurring<array>: [ { day<string>: Monday...Sunday time<string>: HH:MM } ] Optional: eventTimezone<string>: *see list below |
|
|
/{eventId} GET Display event information |
id<int> eventTitle<string> eventUrl<string> registrationUrl<string> eventTimezone eventTime<string> simulatedSchedule<array> presenters<array> attendeeCount<int> isCancelled<bool> |
|
|
/{eventId}/cancelled PUT Cancels an event and prevent further registration |
||
|
/{eventId}/cancelled DELETE Removes cancel status |
||
|
/{eventId}/presenters POST Add an organizer or co-host to the event |
Required: firstName<string> lastName<string> email<string> role<string>: copresenter | organizer |
id<int> accessUrl<string> |
/attendees
|
Path & Method |
Request Parameters |
Success Response Data |
|
/{eventId} POST Register for an event |
Required: firstName<string> email<string> If simulated recurring/hourly (can call /events/{eventId} for accepted dates): eventDateTime<string>: YYYY-MM-DD HH:MM:SS Optional: lastName<string> |
shortcode<string> attendeeUrl<string> |
/media
|
Path & Method |
Request Parameters |
Success Response Data |
|
/ GET List all uploaded media |
Optional: page<int> |
{ media<array> total<int> pageLast<int> pageCurrent<int> } Media Array: id<int> mediaType<string>: video | embed | url thumbnail<string> name<string> status<string> embedCode<string> videoFormat<string>: mp4 | hls videoUrl<string> |
Common Response Codes
|
Error Code |
Response Type |
Schema |
|
200 OK |
Success |
success<bool>: True data<object|array> |
|
400 Bad Request |
Failed |
success<bool>: False error<string>: Specific error message for the request data<object|array>: Error context |
|
403 Forbidden |
Authorization Failed |
|
|
404 Not Found |
Invalid endpoint and/or mismatched method |
|
|
500 Internal Server Error |
Unexpected error occured |
Options:
Timezone (case sensitive):
America/New_York, America/Chicago, America/Denver, America/Phoenix, America/Los_Angeles, America/Anchorage, Pacific/Honolulu, Europe/London, Europe/Paris, Pacific/Midway, America/Adak, Etc/GMT+10, Pacific/Marquesas, Pacific/Gambier, America/Ensenada, Etc/GMT+8, America/Chihuahua, America/Dawson_Creek, America/Belize, America/Cancun, Chile/EasterIsland, America/Havana, America/Bogota, America/Caracas, America/Santiago, America/La_Paz, Atlantic/Stanley, America/Campo_Grande, America/Goose_Bay, America/Glace_Bay, America/St_Johns, America/Araguaina, America/Montevideo, America/Miquelon, America/Godthab, America/Argentina/Buenos_Aires, America/Sao_Paulo, America/Noronha, Atlantic/Cape_Verde, Atlantic/Azores, Europe/Belfast, Europe/Dublin, Europe/Lisbon, Africa/Abidjan, Europe/Amsterdam, Europe/Belgrade, Europe/Brussels, Africa/Algiers, Africa/Windhoek, Asia/Beirut, Africa/Cairo, Asia/Gaza, Africa/Blantyre, Asia/Jerusalem, Europe/Minsk, Asia/Damascus, Europe/Moscow, Africa/Addis_Ababa, Asia/Tehran, Asia/Dubai, Asia/Yerevan, Asia/Kabul, Asia/Yekaterinburg, Asia/Tashkent, Asia/Kolkata, Asia/Katmandu, Asia/Dhaka, Asia/Novosibirsk, Asia/Rangoon, Asia/Bangkok, Asia/Krasnoyarsk, Asia/Manila, Asia/Hong_Kong, Asia/Irkutsk, Australia/Perth, Australia/Eucla, Australia/Melbourne, Asia/Tokyo, Asia/Seoul, Asia/Yakutsk, Australia/Adelaide, Australia/Darwin, Australia/Brisbane, Australia/Hobart, Asia/Vladivostok, Australia/Lord_Howe, Etc/GMT-11, Asia/Magadan, Pacific/Norfolk, Asia/Anadyr, Pacific/Auckland, Etc/GMT-12, Pacific/Chatham, Pacific/Tongatapu, Pacific/Kiritimati
Recurring Days (case-insensitive):
Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
Registration Theme (case sensitive):
Adeline (default), Mesa, Belmont, Oak, Nexgen, Chicago, Clark, Laguna
Comments
0 comments
Please sign in to leave a comment.