WebinarJam and EverWebinar documentation Webinars for everyone!

Get details about one particular webinar from your account

  • Method: webinar
  • Type: POST
  • Complete URL: https://api.webinarjam.com/webinarjam/webinar

 

The request must include all of the required fields, based on the table below:

Name Value
api_key* string(64)
webinar_id* integer

* Required fields

 

The response body will be a JSON object containing a webinar object with the following:

Name Value Parent Description
webinar_id integer Webinar ID
webinar_hash **** string Webinar Hash
name string Webinar Name
description string Webinar Descirption
type string Series of presentations, Single presentation, Always on, Right now
schedules array
date string schedules Date and time of webinar
schedule int schedules Schedule ID
comment string schedules Schedule description
timezone string Webinar timezone
presenters array Presenters
name string presenters Presenter Name
email string presenters Presenter Email
picture string presenters Presenter Image URL
registration_url string Registration URL
registration_type string paid / free
registration_fee int Registration Fee
registration_currency** string Registration Currency
registration_checkout_url** string Registration Checkout URL
registration_post_payment_url** string Registration Post Payment URL
direct_live_room_url*** string Direct URL to the Live room
direct_replay_room_url*** string Direct URL to the Replay room

** This field will be returned only if they are enabled within that particular webinar configuration settings

*** These are generic links to the Live and Replay room, in case you want to send a user directly to those rooms without going through the Registration page

**** webinar_hash: this parameter is used in case you want your API to be able to generate the webinar’s one-click registration link.

 

Example CURL request:

curl --data "api_key=demokey&webinar_id=4" https://api.webinarjam.com/webinarjam/webinar

 

Example return:

{
    "status": "success",
    "webinar": {
        "webinar_id": 4,
        "webinar_hash": "asd4g2",
        "name": "demo4",
        "description": "A series of events",
        "type": "Series of presentations",
        "schedules": [
            {
                "date": "2099-01-01 10:00",
                "schedule": 34,
                "comment": "Friday, 1 January 2099, 10:00 AM"
            },
            {
                "date": "2099-01-02 10:00",
                "schedule": 46,
                "comment": "Saturday, 2 January 2099, 10:00 AM"
            }
        ],
        "timezone": "America/Los_Angeles",
        "presenters": [
            {
                "name": "John Doe",
                "email": "[email protected]",
                "picture": "https://test.s3.amazonaws.com/default_user.jpg"
            }
        ],
        "registration_url": "http://event.webinarjam.com/register/abcd123",
        "registration_type": "free",
        "registration_fee": 0,
        "registration_currency": "",
        "registration_checkout_url": "",
        "registration_post_payment_url": "",
        "direct_live_room_url": "https://event.webinarjam.com/go/live/1/abcd123",
        "direct_replay_room_url": "https://event.webinarjam.com/go/replay/1/abcd123"
    }
}

© 2020 WebinarJam All Rights Reserved