Citrix GoToWebinar enables you to manage a stable and high-performance online webinar environment.
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
Name |
Summary |
Get webinar |
|
List registrants |
|
Add registrant |
|
Get Registrant |
|
List Webinars |
Name |
Summary |
When a webinar is created |
|
When a registrant is added |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
Summary: Get webinar
Description: Retrieves all information about a scheduled webinar.
Syntax:
GoToWebinar.GetWebinar (string webinarKey)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
webinarKey |
string (Webinar key) |
The key of the Webinar. |
True |
Returns:
Type:Webinar
Summary: List registrants
Description: Retrieves a list of all registrants for a specific webinar.
Syntax:
GoToWebinar.ListRegistrations (string webinarKey)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
webinarKey |
string (Webinar key) |
The key of the Webinar. |
True |
Returns:
Type:array of (RegistrantSummary)
Summary: Add registrant
Description: Registers one person, identified by a unique email address, for a webinar.
Syntax:
GoToWebinar.AddRegistrant (string webinarKey, NewRegistrant body)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
webinarKey |
string (Webinar key) |
The key of the Webinar. |
True |
|
body |
|
|
True |
Returns:
Type:RegistrationResult
Summary: Get Registrant
Description: Retrieves details of a specific registrant in a webinar.
Syntax:
GoToWebinar.GetRegistrant (string webinarKey, string registrantKey)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
webinarKey |
string (Webinar key) |
The key of the Webinar. |
True |
|
registrantKey |
string (Registrant key) |
They key of the registrant. |
True |
Returns:
Type:Registrant
Summary: List Webinars
Description: Retrieves a list of all webinars for the authenticated user.
Syntax:
GoToWebinar.ListWebinars ()
Returns:
Type:array of (WebinarSummary)
Summary: When a webinar is created
Description: Triggers when a new webinar is created.
Syntax:
GoToWebinar.OnNewWebinar ()
Returns:
Type:array of (WebinarSummary)
Summary: When a registrant is added
Description: Triggers when a new registrant is added to a webinar.
Syntax:
GoToWebinar.OnNewRegistration (string webinarKey)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
webinarKey |
string (Webinar key) |
The key of the Webinar. |
True |
Returns:
Type:array of (RegistrantSummary)
Summary:
Description:
Properties:
Name |
Type |
Summary |
|
string |
Registrant's email address. |
firstName |
string First name |
Registrant's first name. |
lastName |
string Last name |
Registrant's last name. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
firstName |
string First name |
Registrant's first name. |
lastName |
string Last name |
Registrant's last name. |
unsubscribed |
boolean Unsubscribed |
True if the registrant opted-out from receiving other emails from the webinar's organizer. |
registrationDate |
string(date-time) Registration date-time |
YYYY-MM-DDThh:mm:ssZ (UTC format) |
timeZone |
string Time zone |
Where the webinar will take place. |
responses |
array of (ResponsesItem)
|
|
joinUrl |
string Join Url |
Url the registrant will use to join the webinar. |
type |
string Type |
Sequence or one session. |
registrantKey |
string Registrant Key |
Unique key of the registrant. |
|
string |
Registrant's email address. |
status |
string Status |
Approved, denied or waiting. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
question |
string Registration question |
Custom question for registering. |
answer |
string Registration answer |
Custom answer for registring. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
firstName |
string First name |
Registrant's first name. |
lastName |
string Last name |
Registrant's last name. |
registrationDate |
string(date-time) Registration date-time |
YYYY-MM-DDThh:mm:ssZ (UTC format) |
timeZone |
string Time zone |
Where the webinar will take place. |
joinUrl |
string Join Url |
Url the registrant will use to join the webinar. |
registrantKey |
string Registrant Key |
Unique key of the registrant. |
|
string |
Registrant's email address. |
status |
string Status |
Approved, denied or waiting. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
registrantKey |
string Registrant Key |
Unique key of the registrant. |
joinUrl |
string Join Url |
Url the registrant will use to join the webinar. |
status |
string Status |
Approved, denied or waiting. |
description |
string Description |
Registrant's description. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
webinarKey |
string Webinar key |
Unique key of the webinar. |
numberOfRegistrationLinkClicks |
integer(int32) Registration click count |
Number of registration link clicks. |
times |
array of (TimesItem)
|
|
numberOfRegistrants |
integer(int32) Registrant count |
Number of registrants at the webinar. |
webinarID |
string Webinar Id |
9-digit unique id of the webinar. |
subject |
string Subject |
Webinar's subject. |
description |
string Description |
Webinar's short description. |
timeZone |
string Time Zone |
Where the webinar is taking place. |
inSession |
boolean In session |
True is webinar is currently in progress. |
organizerKey |
integer(int32) Organizer Key |
Unique key of the webinar organizer. |
registrationUrl |
string Registration Url |
Url the invitees can use to register. |
numberOfOpenedInvitations |
integer(int32) Number of opened invitations |
Number of recipients who opened the invitation email to register for the webinar. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
startTime |
string(date-time) Start date-time |
YYYY-MM-DDThh:mm:ssZ (UTC format) |
endTime |
string(date-time) End date-time |
YYYY-MM-DDThh:mm:ssZ (UTC format) |
Summary:
Description:
Properties:
Name |
Type |
Summary |
webinarKey |
string Webinar key |
Unique key of the webinar. |
times |
array of (TimesItem)
|
|
numberOfRegistrants |
integer(int32) Registrant count |
Number of registrants at the webinar. |
webinarID |
string Webinar Id |
9-digit unique id of the webinar. |
subject |
string Subject |
Webinar's subject. |
description |
string Description |
Webinar's short description. |
timeZone |
string Time Zone |
Where the webinar is taking place. |
inSession |
boolean In Session |
True is webinar is currently in progress. |
organizerKey |
integer(int32) Organizer Key |
Unique key of the webinar organizer. |
registrationUrl |
string Registration Url |
Url the invitees can use to register. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
startTime |
string(date-time) Start date-time |
YYYY-MM-DDThh:mm:ssZ (UTC format) |
endTime |
string(date-time) End date-time |
YYYY-MM-DDThh:mm:ssZ (UTC format) |