GoToWebinar (Preview)

GoToWebinar (Preview)

Citrix GoToWebinar enables you to manage a stable and high-performance online webinar environment.

Note:

  • This is a Premium connector.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds
Frequency of trigger polls 1 120 seconds

Actions

Add registrant

Registers one person, identified by a unique email address, for a webinar.

Required Parameters

Webinar key
string
The key of the Webinar.

Optional Parameters

Email
string
Registrant's email address.
First name
string
Registrant's first name.
Last name
string
Registrant's last name.

Returns

Get Registrant

Retrieves details of a specific registrant in a webinar.

Required Parameters

Webinar key
string
The key of the Webinar.
Registrant key
string
They key of the registrant.

Returns

Body
Registrant

Get webinar

Retrieves all information about a scheduled webinar.

Required Parameters

Webinar key
string
The key of the Webinar.

Returns

Body
Webinar

List Webinars

Retrieves a list of all webinars for the authenticated user.

Required Parameters

Webinar key
string
The key of the Webinar.

Optional Parameters

Email
string
Registrant's email address.
First name
string
Registrant's first name.
Last name
string
Registrant's last name.

Returns

Items
Webinars

List registrants

Retrieves a list of all registrants for a specific webinar.

Required Parameters

Webinar key
string
The key of the Webinar.

Returns

Items
Registrants

Triggers

When a registrant is added

Triggers when a new registrant is added to a webinar.

Required Parameters

Webinar key
string
The key of the Webinar.

Returns

When a webinar is created

Triggers when a new webinar is created.

Required Parameters

Webinar key
string
The key of the Webinar.

Returns

Definitions

Webinars

Items
WebinarSummary

Webinar

Description
string
Webinar's short description.
End date-time
date-time
YYYY-MM-DDThh:mm:ssZ (UTC format)
In session
boolean
True is webinar is currently in progress.
Number of opened invitations
integer
Number of recipients who opened the invitation email to register for the webinar.
Organizer Key
integer
Unique key of the webinar organizer.
Registrant count
integer
Number of registrants at the webinar.
Registration Url
string
Url the invitees can use to register.
Registration click count
integer
Number of registration link clicks.
Start date-time
date-time
YYYY-MM-DDThh:mm:ssZ (UTC format)
Subject
string
Webinar's subject.
Time Zone
string
Where the webinar is taking place.
Webinar Id
string
9-digit unique id of the webinar.
Webinar key
string
Unique key of the webinar.
times
array of object

WebinarSummary

Description
string
Webinar's short description.
End date-time
date-time
YYYY-MM-DDThh:mm:ssZ (UTC format)
In Session
boolean
True is webinar is currently in progress.
Organizer Key
integer
Unique key of the webinar organizer.
Registrant count
integer
Number of registrants at the webinar.
Registration Url
string
Url the invitees can use to register.
Start date-time
date-time
YYYY-MM-DDThh:mm:ssZ (UTC format)
Subject
string
Webinar's subject.
Time Zone
string
Where the webinar is taking place.
Webinar Id
string
9-digit unique id of the webinar.
Webinar key
string
Unique key of the webinar.
times
array of object

Registrants

Items
RegistrantSummary

Registrant

Email
string
Registrant's email address.
First name
string
Registrant's first name.
Join Url
string
Url the registrant will use to join the webinar.
Last name
string
Registrant's last name.
Registrant Key
string
Unique key of the registrant.
Registration answer
string
Custom answer for registring.
Registration date-time
date-time
YYYY-MM-DDThh:mm:ssZ (UTC format)
Registration question
string
Custom question for registering.
Status
string
Approved, denied or waiting.
Time zone
string
Where the webinar will take place.
Type
string
Sequence or one session.
Unsubscribed
boolean
True if the registrant opted-out from receiving other emails from the webinar's organizer.
responses
array of object

RegistrantSummary

Email
string
Registrant's email address.
First name
string
Registrant's first name.
Join Url
string
Url the registrant will use to join the webinar.
Last name
string
Registrant's last name.
Registrant Key
string
Unique key of the registrant.
Registration date-time
date-time
YYYY-MM-DDThh:mm:ssZ (UTC format)
Status
string
Approved, denied or waiting.
Time zone
string
Where the webinar will take place.

RegistrationResult

Description
string
Registrant's description.
Join Url
string
Url the registrant will use to join the webinar.
Registrant Key
string
Unique key of the registrant.
Status
string
Approved, denied or waiting.