API & SAML Documentation

Connect your CRM or Marketing Automation Platform to your webcast using our APIs. Any document listed as "Open" will be available for use without any additional credentials needed. All other APIs require an API account to be setup for your company before the integration can begin. Use the SAML documentation for more details on single sign on (SSO) integrations available with the webcast platform. Contact Support to learn more about available options or to request access.

Integrations & API Documentation

Integrations & API Documentation

Submit Registration Data to a Webcast Form

Getting Started

There are two options to submit registration data to a webcast: 

  1. Send registration data to the webcast registration server endpoint, which we will refer to as Webhooks. With Webhooks the end user would remain on the client or 3rd party hosted, non-webcast, website after registration.  
     
    Example Use Case: Take registration on a 3rd party system and leverage a webhook or POST data to server function to automatically register the user within the webcast.
  2. Redirect a user along with their registration data to the webcast, which we will refer to as Frictionless Registration. With Frictionless Registration the end user will be redirected to the webcast and automatically registered and logged into the webcast. 
     
    Example Use Cases: Users login to your website to access a library of events. With a single click the user is taken from your site directly to the webcast player, while the webcast captures the user’s data.  

Webhooks 

Before you get started 

Methods

Method Details 

HTTP Methods 

POST and GET 

Content Type 

text/html 

Response Format 

text/html 


Base Path

https://event.webcasts.com/viewer/regserver.jsp?


Parameters

Parameter 

Required 

Description 

Format

Character Limit 

ei* 

Yes 

Event ID 
(Ex. 1234567) 

Number 

7 

email* 

Yes 

Email Address 

Ascii email 

128 

pass* 

Yes 

Client ID 
(Ex. abcd001) 

Alphanumeric, utf-8 

7 

tp_key*

Yes

Security key in the webcast URL

Alphanumeric, utf-8 

10

unsubscribe* 

Yes, if enabled on the webcast form. 

Unsubscribe to email communications for this specific webcast event ID. 
1 = yes(unsubscribe from communications), 0 = no(do not unsubscribe from communications) 

0, 1 

1 

fname 

No 

First Name 

Alphanumeric, utf-8 

250 

lname 

No 

Last Name 

Alphanumeric, utf-8 

250 

company 

No 

Company Name 

Alphanumeric, utf-8 

250 

title 

No 

Business Title 

Alphanumeric, utf-8 

250 

address1 

No 

Street Address 

Alphanumeric, utf-8 

250 

address2 

No 

Street Address - Extra 

Alphanumeric, utf-8 

250 

city 

No 

City 

Alphanumeric, utf-8 

250 

state 

No 

State 

Alphanumeric, utf-8 

250 

country 

No 

Country 

Alphanumeric, utf-8 

250 

postalcode 

No 

Postal/Zip Code 

Alphanumeric, utf-8 

20 

phone 

No 

Primary Phone Number 

Alphanumeric, utf-8 

20 

cell 

No 

Cell/Mobile Number 

Alphanumeric, utf-8 

20 

fax 

No 

Fax Number 

Alphanumeric, utf-8 

20 

tp_hidden 

No 

A hidden field not shown on the registration form  that does not need to be enabled. 

Alphanumeric, utf-8 

 

 250

sti 

No 

Campaign Source Tracking -designed to track the registration source 

Alphanumeric, utf-8 

 

 250

tp_regconfemail 

No 

Enable a Registration Confirmation Email from the Webcast 

1 

1

customQuestion

No

Non-default webcast registration field

Alphanumeric, utf-8 

250

If the "unsubscribe" field is enabled on the webcast the parameter must be included in the webhook

Example Request

Python

import http.client

conn = http.client.HTTPSConnection("event.webcasts.com")
payload = 'ei=1111111&pass=abcd001&email=example%40webcasts.com&fname=Amelia&lname=Earhart'
headers = {
  'Content-Type': 'application/x-www-form-urlencoded',
  'Cookie': 'JSESSIONID=C199ABD14256D74D9EA2AA8B7F84B92E'
}
conn.request("POST", "/viewer/regserver.jsp", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Return Messages

Message Description
"Success."
The registration has been successfully submitted to the event.
"Event not found."
Invalid Event ID
"Unauthorized."
The client pass ID does not have access to the Event ID.
"Registration for this event is prohibited."
The event is configured for anonymous registration.
"Email not found."
A valid email address is required for registration. This message indicates an email was not passed.
"Email format not valid."
Invalid email formatting
"User already registered."
An audience member is already registered for the event ID based on email address.
"No reg data sent."
General error - Contact Support for help.

Frictionless Registration 

Before you get started 

Methods

Method Details 

HTTP Methods 

POST and GET 

Content Type 

text/html 

Response Format 

text/html 

Base Path

https://event.webcasts.com/starthere.jsp?

Parameters

Parameter 

Required 

Description 

Format

Character Limit 

ei* 

Yes 

Event ID 
(Ex. 1234567) 

Number 

7 

email* 

Yes 

Email Address 

Ascii email 

128 

tp_key*

Yes, if enabled on the webcast

Optional security key in the webcast URL

Alphanumeric, utf-8

10

unsubscribe 

No 

Unsubscribe to email communications for this specific webcast event ID. 
1 = yes(unsubscribe from communications), 0 = no(do not unsubscribe from communications) 

0, 1 

1 

fname 

No 

First Name 

Alphanumeric, utf-8 

250 

lname 

No 

Last Name 

Alphanumeric, utf-8 

250 

company 

No 

Company Name 

Alphanumeric, utf-8 

250 

title 

No 

Business Title 

Alphanumeric, utf-8 

250 

address1 

No 

Street Address 

Alphanumeric, utf-8 

250 

address2 

No 

Street Address - Extra 

Alphanumeric, utf-8 

250 

city 

No 

City 

Alphanumeric, utf-8 

250 

state 

No 

State 

Alphanumeric, utf-8 

250 

country 

No 

Country 

Alphanumeric, utf-8 

250 

postalcode 

No 

Postal/Zip Code 

Alphanumeric, utf-8 

20 

phone 

No 

Primary Phone Number 

Alphanumeric, utf-8 

20 

cell 

No 

Cell/Mobile Number 

Alphanumeric, utf-8 

20 

fax 

No 

Fax Number 

Alphanumeric, utf-8 

20 

tp_hidden 

No 

A hidden field not shown on the registration form  that does not need to be enabled. 

Alphanumeric, utf-8 

 

 250

sti 

No 

Campaign Source Tracking -designed to track the registration source 

Alphanumeric, utf-8 

 

 250

tp_regconfemail 

No 

Enable a Registration Confirmation Email from the Webcast 

1 

1 

customQuestion

No

Non-default webcast registration field

Alphanumeric, utf-8 

250

Example URL

https://event.webcasts.com/starthere.jsp?ei=1111111&tp_key=ab123c4567&email=example@webcasts.com

Custom Registration Questions 

For both Webhooks and Frictionless registration any non-default webcast registration field is known as a custom registration question. All default registration questions are listed above. Please familiarize yourself with the below to ensure data for your custom webcast registration questions are captured. 

Example Workflow 

Setup client hosted registration page and webcast, both will all desired registration fields enabled. The client hosted form would leverage Webhooks to pass registrant data to the webcast while keeping the registrant on your website. The webcast would have registration closed and include a link back to the client hosted registration page. This ensures your marketing automation platform has up to date information for tasks like re-invites. The confirmation and reminder emails leverage frictionless registration links so viewers are automatically placed in the webcast player with a single click. 

To close / hide the registration form on the webcast, but still allow registration to flow from your 3rd party registration page you can close registration from the “Manage Access” button under “Event Details” on the Event Summary page of any webcast. 

Integrations & API Documentation

Marketo Integration

Integration Overview

The Webcast Marketo Integration offers the capability to pass webcast data into Marketo as well as take registration for a webcast on a Marketo form. 

The Webcast Activity Feed is an integration managed by the webcast team that allows you to create / update leads, create custom activity records and capture interaction data in custom objects

The Registration Integration allows you to take registration on a Marketo form to leverage the Marketo intelligence and support your overall marketing campaign steps, while seamlessly registering the user for the webcast.

Webcast Activity Feed

Activity Feed Overview

The Webcasts Activity Feed sends webcast registration, attendance and interaction data into Marketo. This document outlines the specific data that passes with the integration, as well as setup steps required to complete the integration. The Marketo activity feed is facilitated by Workato.

The webcast activity feed is setup and managed by the webcast team, please use the form to request the required support.

Included Data and Endpoints

Clients are able to customize which data and endpoints listed below are included with their implementation. This will be confirmed during the meeting with a webcast integration specialist.

Requirements

Custom Objects

Object Name: Webcast Registration Viewer Data

Field Name

Required

Description

Field Type

External ID

Yes

Stores unique values which connect the data between the webcast and Marketo 

string(Dedupe YES)

Lead ID

Yes

Connects the custom object record to the corresponding lead

link(Link Object: Lead, Link Field: Id, Dedupe: NO)

Address1

No

Street Address 1

string

Address2

No

Street Address 2

string

Attended

No

Did the webcast registrant view, at least a portion, the webcast

boolean

Campaign Source

No

Track the marketing channel that drove webcast registration

string

Certificate Link

No

Link to download the user's certificate, if applicable

string

Certification Results

No

Did the user pass the requirements to receive CE credit

string

City

No

City

string

Company

No

Company

string

Cost Center

No

Text field in the webcast setup, generally utilized to capture sponsor or billing code information

string

Country

No

Country

string

Custom Registration

No

Non-default webcast registration field. The actual field name implemented should not be "Custom Registration" but reflect the information captured

string

Email

No

Email

email

Fax Number

No

Fax Number

string

First Name

No

First Name

string

Hidden Field

No

A registration field that is hidden on the webcast registration form. Similar to the "Custom Registration" field a different field name can be chosen for this field.

string

IP Address

No

IP Address

string

Last Name

No

Last Name

string

Live Session Duration

No

The amount of time the user viewed the webcast live

integer

Mobile Number

No

Mobile number

string

OD Session Duration

No

The amount of time the user viewed the webcast in their most recent on-demand session

integer

Phone Number

No

Phone Number

string

Postal Code

No

Postal or ZIP Code

string

Referrer

No

The address of the website the user accessed the webcast URL from, if included in the browser header.

string

Registration Date

No

Date of user registration for the webcast

datetime

Sim Live Duration

No

The amount of time the user viewed the webcast in their most recent simulated-live session

integer

State

No

State or Province

string

Title

No

Job Title

string

Unsubscribed

No

Unsubscribe to email communications for this specific webcast event ID. 

checked(unsubscribed from communications), unchecked(did not unsubscribe from communications)

boolean

User Agent

No

 A characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.

string

Webcast Event ID

No

Unique id of the corresponding webcast event

string

Webcast Event Title

No

Title of the corresponding webcast event

string

Object Name: Webcast Survey QA Data

Field Name

Required

Description

Field Type

External ID

Yes

Stores unique values which connect the data between the webcast and Marketo 

string(Dedupe YES)

Lead ID

Yes

Connects the custom object record to the corresponding lead

link(Link Object: Lead, Link Field: Id, Dedupe: NO)

Answer

No

Depending on "Record Type" it is either a viewer's response to a poll/survey or an admin's response to a viewer question

string

Campaign Source

No

Track the marketing channel that drove webcast registration

string

Email

No

Email

email

Question

No

Depending on "Record Type" it is either a viewer question or the question for a poll/survey

string

Record Type

No

QA: Is a viewer question

In-Event: Is a survey/poll sent during the webcast

Post-Event: Is a survey responded to after the conclusion of the webcast

string

Webcast Event ID

No

Unique id of the corresponding webcast event

string

Webcast Event Title

No

Title of the corresponding webcast event

string

NOTE: Custom Objects can be setup on the Admin > Database Management > Marketo Custom Objects page. You may need to enlist the assistance of your company's Marketo administrator to complete the below steps.

If you need additional information on creating Custom Objects in Marketo, please contact Marketo Support.

When initially creating the custom objects enable the objects to show in the lead detail.  Be sure to approve the custom objects once they are created

Custom Activity

Activity Name: Webcast Viewing Session

Field Name

Required

Description

Field Type

leadId

Yes

Id of the lead associated to the activity

integer(included by default)

Webcast View

Yes

Type of webcast view session, ie. Live, On-Demand, Simulated Live

string(Primary Attribute Value)

Webcast Event ID

Yes

The webcast event id that was viewed

string

Implementation Process

To facilitate the integration implementation you will need to schedule a meeting with an integration specialist to review the specific requirements for your integration, which were outlined in the completed form. The integration process is handled almost entirely by the webcast team, there are a couple steps you will need to complete:

  1. Create the two custom objects and/or the custom activity in Marketo to store webcast activity data

  1. Connect Workato to Marketo. It is recommended that the initial integration setup be completed using a sandbox environment, if available. The connection to Workato will be completed during your implementation call, but you can review the process by watching the Workato Connection Setup Tutorial.

Registration Integration

Introduction

Seamlessly register users for a webcast events using a Marketo form. The process does not require the audience member to load any pages from the webcast within their browser to register. This integration leverages Marketo webhooks, allowing for setup and testing at your convenience. 

Before you get started

Create a lead field to store the webcast event ID

In order to populate the Webcast Event ID in the Webhook a custom field needs to be setup.

1. After logging in to your Marketo account, in the top right of your screen, click "Admin".

Marketo


2. Along the left of your screen under "Database Management", click "Field Management".

Marketo



3. At the top of the screen, click "New Custom Field".

Marketo



4. In the custom field setup, select ""Integer" as the "Type. Add a "Name" that you can easily identify later. "webcast ID" is used for this example.

Marketo


Creating a Webhook in Marketo

A webhook is used to send a user's registration data to a webcast when they register with a Marketo form. A Marketo webhook only needs to be created a single time and can be leveraged across all webcasts.

Data captured in the Marketo form will only be sent to the Webcast if that field is enabled on the webcast registration form.

1. After logging in to your Marketo account, in the top right of your screen, click "Admin".

Marketo


2. Along the left of your screen under "Integration", click "Webhooks".

Marketo



3. At the top of your screen under "Webhooks", click "New Webhook".

Marketo



4. Fill out the required fields to create a new Webhook. In the Webhook Name field, title the Webhook you are creating. In the URL field, enter the desired Webhook URL and then insert the corresponding Marketo tokens. Refer to the detailed instructions below on customizing the Marketo Webhook URL and selecting the proper Webhook settings.

Marketo

Request Type
Post

Webhook URL Configuration
Below is an example of a default Webhook URL, without the Marketo tokens
. The URL you use should include any parameters (registration fields) you would like captured in the Webcast's reports. It is recommended to be inclusive of any potential fields you may wish to pass. The Webhook call is unaffected if additional fields, not enabled on the webcast, are passed, as long as they are not required fields.  Refer to the notes and table below for instructions on customizing the link for your event.

Example URL
https://event.webcasts.com/viewer/regserver.jsp?ei=1234567&fname=FirstName&lname=LastName&company=CompanyName&title=BusinessTitle&address1=StreetAddress&address2=StreetAddress2&city=City&state=State&country=Country&postalcode=PostalCode&phone=PhoneNumber&cell=CellNumber&fax=FaxNumber&email=Email@Address.com&custom_question1=CustomQuestionAnswer1&pass=abcd001&tp_regconfemail=1

Once the Server Side Registration URL has been entered into the URL field, click "Insert Token" next to the URL field and replace each default value from the Server Side Registration URL with the appropriate Token from Marketo.

Replace "FirstName" from the Server Side Registration URL with "{{lead.First Name:default=edit me}}" Token from Marketo.

Request Token Encoding
Form/URL

Webcast Parameters

Parameter 

Required 

Description 

Values 

Character Limit 

ei* 

Yes 

Event ID 
(Ex. 1234567) 

Number 

7 

email* 

Yes 

Email Address 

Ascii email 

128 

pass* 

Yes 

Client ID 
(Ex. abcd001) 

Alphanumeric, utf-8 

7 

unsubscribe* 

Yes, if enabled on the webcast form. 

Unsubscribe to email communications for this specific webcast event ID. 
1 = yes(unsubscribe from communications), 0 = no(do not unsubscribe from communications) 

0, 1 

1 

fname 

No 

First Name 

Alphanumeric, utf-8 

250 

lname 

No 

Last Name 

Alphanumeric, utf-8 

250 

company 

No 

Company Name 

Alphanumeric, utf-8 

250 

title 

No 

Business Title 

Alphanumeric, utf-8 

250 

address1 

No 

Street Address 

Alphanumeric, utf-8 

250 

address2 

No 

Street Address - Extra 

Alphanumeric, utf-8 

250 

city 

No 

City 

Alphanumeric, utf-8 

250 

state 

No 

State 

Alphanumeric, utf-8 

250 

country 

No 

Country 

Alphanumeric, utf-8 

250 

postalcode 

No 

Postal/Zip Code 

Alphanumeric, utf-8 

20 

phone 

No 

Primary Phone Number 

Alphanumeric, utf-8 

20 

cell 

No 

Cell/Mobile Number 

Alphanumeric, utf-8 

20 

fax 

No 

Fax Number 

Alphanumeric, utf-8 

20 

tp_hidden 

No 

A hidden field not shown on the registration form  that does not need to be enabled. 

Alphanumeric, utf-8 

 

 250

sti 

No 

Campaign Source Tracking -designed to track the registration source 

Alphanumeric, utf-8 

 

 250

tp_regconfemail 

No 

Enable a Registration Confirmation Email from the Webcast 

1 

1

customQuestion

No

Non-default webcast registration field

Alphanumeric, utf-8 

250

Custom Registration Questions

Any non-default webcast registration field is known as a custom registration question. All default registration questions are listed above. Please familiarize yourself with the below to ensure data for your custom webcast registration questions are captured. 

 

Return Messages

 

Message

Description

"Success."

The registration has been successfully submitted to the event.

"Event not found."

Invalid Event ID

"Unauthorized."

The client pass ID does not have access to the Event ID.

"Registration for this event is prohibited."

The event is configured for anonymous registration.

"Email not found."

A valid email address is required for registration. This message indicates an email was not passed.

"Email format not valid."

Invalid email formatting

"User already registered."

An audience member is already registered for the event ID based on email address.

"No reg data sent."

General error - Contact Support for help.

Marketo Campaign Setup

Once the Webhook is setup in Marketo, a Campaign needs to be created, which is used to activate the Webhook when a user registers on a Marketo Landing Page. These instructions allow a single registration form to be used for multiple events.

1. At the top left of your screen, click on the Marketo logo and select "Marketing Activities".

Marketo

2. In the center of your screen in the "Smart Campaigns" section, click "New Smart Campaign".

Marketo



3. In the new window, select a Campaign Folder using the dropdown and add a name using the Campaign Name field. Click "Create" once complete.

Marketo



4. Once the campaign is created, click "Smart List" to select when this campaign will take affect.

Marketo



5. Along the right side of your screen under "Triggers", select the "Fills Out Form" field and drag it into the box in the center of your screen.

Marketo


6. Select the Form that will be used to capture registration. This means the Campaign is triggered anytime someone completes the selected Form.

Marketo



7. Next, click "Flow" to select what actions will be taken.

Marketo


8. Along the right side of your screen under "Marketing", select "Change Data Value" and drag it into the box in the center of your screen. Set the "Attribute" to the custom field you just created (Ex. "webcastID" in this example). Set the "New Value" to the Event ID for your presentation.

Marketo


9. Along the right side of your screen under "Integration", select the "Call Webhook" field and drag it into the box in the center of your screen.  Select the Webhook you previously created using the dropdown. This will trigger the Webhook you created anytime someone completes the Form selected on the previous step.

Marketo


11. Next, click "Schedule" to active the Campaign.

Marketo



12. Click "Activate" to make the Campaign active. Once activated, the campaign will appear in the selected folder with a light bulb indicator.

Marketo

Test the Setup

Once the setup is complete, any submissions of the Marketo form should appear in the Webcast reports nearly immediately. To test the setup, submit a sample registration through the Marketo form.

1. In the Webcast platform, select the Webcast where data should be passing and choose the "Reports" button below.


Marketo



2. In the Reports interface, choose the "Audience Details" report (default) and click "Run My Report". The report that displays will include any registration fields passed in the setup, but will have blank fields for any data that was not passed or is related to audience participation.


Marketo



3. If all the data appears correct in the reports, no further action is needed. If some or all of the data is not received, review the Server Side Registration URL used in setup and confirm all fields have been correctly mapped.
Integrations & API Documentation

Eloqua Integration

Integration Overview

The Webcast Eloqua Integration offers the capability to pass webcast data into Eloqua as well as take registration for a webcast on a Eloqua form. 

The Webcast Activity Feed is an integration managed by the webcast team that allows you to create / update leads, create custom activity records and capture interaction data in custom objects

The Registration Integration allows you to take registration on a Eloqua form to leverage the Eloqua intelligence and support your overall marketing campaign steps, while seamlessly registering the user for the webcast.

Webcast Activity Feed

Activity Feed Overview

The Webcasts Activity Feed sends webcast registration, attendance and interaction data into Eloqua. This document outlines the specific data that passes with the integration, as well as setup steps required to complete the integration. The Eloqua activity feed is facilitated by Workato.

The webcast activity feed is setup and managed by the webcast team, please use the form to request the required support.

Included Data and Endpoints

Clients are able to customize which data and endpoints listed below are included with their implementation. This will be confirmed during the meeting with a webcast integration specialist.

Requirements

Custom Objects

Custom Object Records will be tied to the corresponding contact record, if a match is available.

Object Name: Webcast Registration Viewer Data

Field Name

Required

Description

Field Type

External ID

Yes

Stores unique values which connect the data between the webcast and Eloqua

text/textbox(set as unique code field for Custom Object)

Address1

No

Street Address 1

text/textbox

Address2

No

Street Address 2

text/textbox

Attended

No

Did the webcast registrant view, at least a portion, the webcast

text/checkbox

Campaign Source

No

Track the marketing channel that drove webcast registration

text/textbox

Certificate Link

No

Link to download the user's certificate, if applicable

text/textbox

Certification Results

No

Did the user pass the requirements to receive CE credit

text/textbox

City

No

City

text/textbox

Company

No

Company

text/textbox

Cost Center

No

Text field in the webcast setup, generally utilized to capture sponsor or billing code information

text/textbox

Country

No

Country

text/textbox

Custom Registration

No

Non-default webcast registration field. The actual field name implemented should not be "Custom Registration" but reflect the information captured

text/textbox

Email

No

Email

text/textbox(set as email address field for Custom Object)

Fax Number

No

Fax Number

text/textbox

First Name

No

First Name

text/textbox

Hidden Field

No

A registration field that is hidden on the webcast registration form. Similar to the "Custom Registration" field a different field name can be chosen for this field.

text/textbox

IP Address

No

IP Address

text/textbox

Last Name

No

Last Name

text/textbox

Live Session Duration

No

The amount of time the user viewed the webcast live

number/textbox

Mobile Number

No

Mobile number

text/textbox

OD Session Duration

No

The amount of time the user viewed the webcast in their most recent on-demand session

number/textbox

Phone Number

No

Phone Number

text/textbox

Postal Code

No

Postal or ZIP Code

text/textbox

Referrer

No

The address of the website the user accessed the webcast URL from, if included in the browser header.

text/textbox

Registration Date

No

Date of user registration for the webcast

date-time/textbox

Sim Live Duration

No

The amount of time the user viewed the webcast in their most recent simulated-live session

number/textbox

State

No

State or Province

text/textbox

Title

No

Job Title

text/textbox

Unsubscribed

No

Unsubscribe to email communications for this specific webcast event ID. 

checked(unsubscribed from communications), unchecked(did not unsubscribe from communications)

text/checkbox

User Agent

No

 A characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.

text/textbox

Webcast Event ID

No

Unique id of the corresponding webcast event

text/textbox

Webcast Event Title

No

Title of the corresponding webcast event

text/textbox

Object Name: Webcast Survey QA Data

Field Name

Required

Description

Field Type

External ID

Yes

Stores unique values which connect the data between the webcast and Eloqua

text/textbox(set as unique code field for Custom Object)

Answer

No

Depending on "Record Type" it is either a viewer's response to a poll/survey or an admin's response to a viewer question

large text/textbox

Campaign Source

No

Track the marketing channel that drove webcast registration

text/checkbox

Email

No

Email

text/textbox(set as email address field for Custom Object)

Question

No

Depending on "Record Type" it is either a viewer question or the question for a poll/survey

large text/textbox

Record Type

No

QA: Is a viewer question

In-Event: Is a survey/poll sent during the webcast

Post-Event: Is a survey responded to after the conclusion of the webcast

text/textbox

Webcast Event ID

No

Unique id of the corresponding webcast event

text/textbox

Webcast Event Title

No

Title of the corresponding webcast event

text/textbox

If you need information on how to create Custom Objects in Eloqua, please contact Eloqua Support.

Implementation Process

To facilitate the integration implementation you will need to schedule a meeting with an integration specialist to review the specific requirements for your integration, which were outlined in the completed form. The integration process is handled almost entirely by the webcast team, there are a couple steps you will need to complete:

  1. Create the two custom objects in Eloqua to store webcast activity data

 
  1. Connect Workato to Eloqua. It is recommended that the initial integration setup be completed using a sandbox environment, if available. The connection to Workato will be completed during your implementation call, but you can review the process by watching the Workato Connection Setup Tutorial.

Registration Integration

Introduction

 

Seamlessly register users for a webcast events using a Eloqua form. The process does not require the audience member to load any pages from the webcast within their browser to register. This integration leverages Eloqua's "Post Data to Server" form processing step, allowing for setup and testing at your convenience. 

Before you get started

 

Create a contact field to store the webcast event ID

In order to populate the Webcast Event ID in the Post Data To Server call a custom contact field needs to be setup. The name of the field is up to your discretion, but it is recommended to use an easily identifiable name, e.g., "Webcast Event Id".

Post Data to Server

1. After the Eloqua form setup is complete, click "Processing" in the top right.

Eloqua


2. Click "+" and double-click on the "Post Data to Server" option in the menu.

Eloqua


3. Select "Constant Value" in the dropdown and enter the Server Side Registration URL configured for the event you want to receive the submitted data.
Eloqua

URL Configuration
Below is an example of a default URL. The URL you use should include any parameters (registration fields) you would like captured in the Webcast's reports. It is recommended to be inclusive of any potential fields you may wish to pass. The Post Data to Server call is unaffected if additional fields, not enabled on the webcast, are passed, as long as they are not required fields.  Refer to the notes and table below for instructions on customizing the link for your event.

Example URL
https://event.webcasts.com/viewer/regserver.jsp?ei=1234567&fname=FirstName&lname=LastName&company=CompanyName&title=BusinessTitle&address1=StreetAddress&address2=StreetAddress2&city=City&state=State&country=Country&postalcode=PostalCode&phone=PhoneNumber&cell=CellNumber&fax=FaxNumber&email=Email@Address.com&custom_question1=CustomQuestionAnswer1&pass=abcd001&tp_regconfemail=1

 

Field Mapping
The field mapping between the form Source Fields(Eloqua) and the Target Fields(Webcast)  are set up automatically based on the HTML names of the Source Fields. These fields need to match the parameters below.

Webcast Parameters

Parameter 

Required 

Description 

Values 

Character Limit 

ei* 

Yes 

Event ID 
(Ex. 1234567) 

Number 

7 

email* 

Yes 

Email Address 

Ascii email 

128 

pass* 

Yes 

Client ID 
(Ex. abcd001) 

Alphanumeric, utf-8 

7 

unsubscribe* 

Yes, if enabled on the webcast form. 

Unsubscribe to email communications for this specific webcast event ID. 
1 = yes(unsubscribe from communications), 0 = no(do not unsubscribe from communications) 

0, 1 

1 

fname 

No 

First Name 

Alphanumeric, utf-8 

250 

lname 

No 

Last Name 

Alphanumeric, utf-8 

250 

company 

No 

Company Name 

Alphanumeric, utf-8 

250 

title 

No 

Business Title 

Alphanumeric, utf-8 

250 

address1 

No 

Street Address 

Alphanumeric, utf-8 

250 

address2 

No 

Street Address - Extra 

Alphanumeric, utf-8 

250 

city 

No 

City 

Alphanumeric, utf-8 

250 

state 

No 

State 

Alphanumeric, utf-8 

250 

country 

No 

Country 

Alphanumeric, utf-8 

250 

postalcode 

No 

Postal/Zip Code 

Alphanumeric, utf-8 

20 

phone 

No 

Primary Phone Number 

Alphanumeric, utf-8 

20 

cell 

No 

Cell/Mobile Number 

Alphanumeric, utf-8 

20 

fax 

No 

Fax Number 

Alphanumeric, utf-8 

20 

tp_hidden 

No 

A hidden field not shown on the registration form  that does not need to be enabled. 

Alphanumeric, utf-8 

 

 250

sti 

No 

Campaign Source Tracking -designed to track the registration source 

Alphanumeric, utf-8 

 

 250

tp_regconfemail 

No 

Enable a Registration Confirmation Email from the Webcast 

1 

1

customQuestion

No

Non-default webcast registration field

Alphanumeric, utf-8 

250

Custom Registration Questions

Any non-default webcast registration field is known as a custom registration question. All default registration questions are listed above. Please familiarize yourself with the below to ensure data for your custom webcast registration questions are captured. 

 

Return Messages

 

Message

Description

"Success."

The registration has been successfully submitted to the event.

"Event not found."

Invalid Event ID

"Unauthorized."

The client pass ID does not have access to the Event ID.

"Registration for this event is prohibited."

The event is configured for anonymous registration.

"Email not found."

A valid email address is required for registration. This message indicates an email was not passed.

"Email format not valid."

Invalid email formatting

"User already registered."

An audience member is already registered for the event ID based on email address.

"No reg data sent."

General error - Contact Support for help.

Test the Setup

Once the setup is complete, any submissions of the Eloqua form should appear in the Webcast reports nearly immeadiately. To test the setup, submit a sample registration through the Eloqua form.

1. In the Webcast platform, select the Webcast where data should be passing and choose the "Reports" button below.

Eloqua

2. In the Reports interface, choose the "Audience Details" report (default) and click "Run My Report". The report that displays will include any registration fields passed in the setup, but will have blank fields for any data that was not passed or is related to audience participation.

Eloqua

3. If all the data appears correct in the reports, no further action is needed. If some or all of the data is not received, review the Server Side Registration URL used in setup and confirm all fields have been correctly mapped.

Integrations & API Documentation

Cvent Integration

Integration Overview

The Webcast Cvent Integration offers the capability to pass webcast participation data into Cvent as well as pull registration data from Cvent. The Cvent Integration is facilitated by Workato.

The Cvent Integration is setup and managed by the webcast team, please use the form to request the required support.

Event Participation  allows you to send Event Participation flags to Cvent.

The Registration Integration allows you to take registration with Cvent and register the user for a webcast automatically.

The Cvent integration requires a Cvent API account. Please contact the Cvent support team for assistance if you do not currently have an account.

Event Participation

 

The Event Participation allows you to send Event Participation flags to Cvent. The Event Participation flag is set when a user attends a live, on-demand or simulated live webcast. These settings can be customized, please discuss with the integration team when setting up your managed integration.

image-1695230633916.png

Registration Integration

When you contact us regarding a Managed Integration, we will discuss all the individual fields that are available and setup the connection as required for your project. Typically, the fields that are passed match with standard webcast registration fields, such as:

Some custom fields such as Cvent EventID or Event Title can be passed as well but will require creating custom fields for each webcast to capture them.Once your managed integration is setup with our support team, you will enable the registration pass in the Cvent platform by entering your Webcast EventID in the Custom Fields section of the Event Information settings.

Integrations & API Documentation

Salesforce Integration

Integration Overview

The Webcast Salesforce Integration offers the capability to pass webcast data into Salesforce. The Webcast Activity Feed is an integration managed by the webcast team that allows you to  create / update contacts, create / update leads, update campaigns, and capture interaction data in custom objects.

Webcast Activity Feed

Activity Feed Overview

The Webcasts Activity Feed sends webcast registration, attendance and interaction data into Salesforce. This document outlines the specific data that passes with the integration, as well as setup steps required to complete the integration. The Salesforce activity feed is facilitated by Workato.

The webcast activity feed is setup and managed by the webcast team, please use the form to request the required support.

Included Data and Endpoints

Clients are able to customize which data and endpoints listed below are included with their implementation. This will be confirmed during the meeting with a webcast integration specialist.

 

Requirements

Custom Objects

Object Name: Webcast Registration Viewer Data

Field Name

Required

Description

Field Type

External ID

Yes

Stores unique values which connect the data between the webcast and Salesforce

text, 255 characters (External ID)
*screenshot below

Address1

No

Street Address 1

text, 255 characters

Address2

No

Street Address 2

text, 255 characters

Attended

No

Did the webcast registrant view, at least a portion, the webcast

checkbox (default value: unchecked)

Campaign Source

No

Track the marketing channel that drove webcast registration

text, 255 characters

Certificate Link

No

Link to download the user's certificate, if applicable

text, 255 characters

Certification Results

No

Did the user pass the requirements to receive CE credit

text, 255 characters

City

No

City

text, 255 characters

Company

No

Company

text, 255 characters

Contact

No

Connects the custom object record to the corresponding contact, if contact exists

Lookup Relationship (Contact)

Cost Center

No

Text field in the webcast setup, generally utilized to capture sponsor or billing code information

text, 255 characters

Country

No

Country

text, 255 characters

Custom Registration

No

Non-default webcast registration field. The actual field name implemented should not be "Custom Registration" but reflect the information captured

text, 255 characters

Email

No

Email

email

Fax Number

No

Fax Number

text, 255 characters

First Name

No

First Name

text, 255 characters

Hidden Field

No

A registration field that is hidden on the webcast registration form. Similar to the "Custom Registration" field a different field name can be chosen for this field.

text, 255 characters

IP Address

No

IP Address

text, 255 characters

Last Name

No

Last Name

text, 255 characters

Lead

No

Connects the custom object record to the corresponding lead, if lead exists

Lookup Relationship (Lead)

Live Session Duration

No

The amount of time the user viewed the webcast live

number

(length: 18, decimal: 0)

Mobile Number

No

Mobile number

text, 255 characters

OD Session Duration

No

The amount of time the user viewed the webcast in their most recent on-demand session

number

(length: 18, decimal: 0)

Phone Number

No

Phone Number

text, 255 characters

Postal Code

No

Postal or ZIP Code

text, 255 characters

Referrer

No

The address of the website the user accessed the webcast URL from, if included in the browser header.

text, 255 characters

Registration Date

No

Date of user registration for the webcast

date/time

Sim Live Duration

No

The amount of time the user viewed the webcast in their most recent simulated-live session

number

(length: 18, decimal: 0)

State

No

State or Province

text, 255 characters

Title

No

Job Title

text, 255 characters

Unsubscribed

No

Unsubscribe to email communications for this specific webcast event ID. 

checked(unsubscribed from communications), unchecked(did not unsubscribe from communications)

checkbox (default value: unchecked)

User Agent

No

 A characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.

text, 255 characters

Webcast Event ID

No

Unique id of the corresponding webcast event

text, 255 characters

Webcast Event Title

No

Title of the corresponding webcast event

text, 255 characters

External ID

Object Name: Webcast Survey QA Data

Field Name

Required

Description

Field Type

External ID

Yes

Stores unique values which connect the data between the webcast and Salesforce

text, 255 characters (External ID)
*screenshot above

Answer

No

Depending on "Record Type" it is either a viewer's response to a poll/survey or an admin's response to a viewer question

text area, long

Campaign Source

No

Track the marketing channel that drove webcast registration

text, 255 characters

Contact

No

Connects the custom object record to the corresponding contact, if contact exists

Lookup Relationship (Contact)

Email

No

Email

email

Lead

No

Connects the custom object record to the corresponding lead, if lead exists

Lookup Relationship (Lead)

Question

No

Depending on "Record Type" it is either a viewer question or the question for a poll/survey

text area, long

Record Type

No

QA: Is a viewer question

In-Event: Is a survey/poll sent during the webcast

Post-Event: Is a survey responded to after the conclusion of the webcast

text, 255 characters

Webcast Event ID

No

Unique id of the corresponding webcast event

text, 255 characters

Webcast Event Title

No

Title of the corresponding webcast event

text, 255 characters

If you need additional information on creating Custom Objects in Salesforce, please contact Salesforce Support.

Salesforce Campaigns

In order for the webcast registration and attendance data to update campaigns a "webcast_id" field needs to be added to Salesforce campaigns. Enter the corresponding 7 digit webcast id into this field.

Additionally, the integration's default status fields are:

Implementation Process

 

To facilitate the integration implementation you will need to schedule a meeting with an integration specialist to review the specific requirements for your integration, which were outlined in the completed form. The integration process is handled almost entirely by the webcast team, there are a couple steps you will need to complete:

  1. Create the two custom objects and add the "webcast_id" field to campaigns in Salesforce to store webcast activity data.

  1. Connect Workato to Salesforce. It is recommended that the initial integration setup be completed using a sandbox environment, if available. The connection to Workato will be completed during your implementation call, but you can review the process by watching the Workato Connection Setup Tutorial.

Integrations & API Documentation

Microsoft Dynamics 365

Integration Overview

The Webcast Dynamics 365 Integration offers the capability to pass webcast data into Microsoft Dynamics. The Webcast Activity Feed is an integration managed by the webcast team that allows you to  create / update contacts, create / update leads, update campaigns, and capture interaction data in custom objects.

Webcast Activity Feed

Activity Feed Overview

The Webcasts Activity Feed sends webcast registration, attendance and interaction data into Microsoft Dynamics. This document outlines the specific data that passes with the integration, as well as setup steps required to complete the integration. The Microsoft Dynamics activity feed is facilitated by Workato.

The webcast activity feed is setup and managed by the webcast team, please use the form to request the required support.

Included Data and Endpoints

Clients are able to customize which data and endpoints listed below are included with their implementation. This will be confirmed during the meeting with a webcast integration specialist.

Requirements

Custom Entities

Entity Name: Webcast Registration Viewer Data

Field Name

Required

Description

Field Type

External ID

Yes

Stores unique values which connect the data between the webcast and Dynamics

text, 255 characters (External ID)

Address1

No

Street Address 1

text, 255 characters

Address2

No

Street Address 2

text, 255 characters

Attended

No

Did the webcast registrant view, at least a portion, the webcast

checkbox (default value: unchecked)

Campaign Source

No

Track the marketing channel that drove webcast registration

text, 255 characters

Certificate Link

No

Link to download the user's certificate, if applicable

text, 255 characters

Certification Results

No

Did the user pass the requirements to receive CE credit

text, 255 characters

City

No

City

text, 255 characters

Company

No

Company

text, 255 characters

Contact

No

Connects the custom object record to the corresponding contact, if contact exists

Contact ID

Cost Center

No

Text field in the webcast setup, generally utilized to capture sponsor or billing code information

text, 255 characters

Country

No

Country

text, 255 characters

Custom Registration

No

Non-default webcast registration field. The actual field name implemented should not be "Custom Registration" but reflect the information captured

text, 255 characters

Email

No

Email

email

Fax Number

No

Fax Number

text, 255 characters

First Name

No

First Name

text, 255 characters

Hidden Field

No

A registration field that is hidden on the webcast registration form. Similar to the "Custom Registration" field a different field name can be chosen for this field.

text, 255 characters

IP Address

No

IP Address

text, 255 characters

Last Name

No

Last Name

text, 255 characters

Lead

No

Connects the custom object record to the corresponding lead, if lead exists

Lead ID

Live Session Duration

No

The amount of time the user viewed the webcast live

int
(length: 18, decimal: 0)

Mobile Number

No

Mobile number

text, 255 characters

OD Session Duration

No

The amount of time the user viewed the webcast in their most recent on-demand session

int
(length: 18, decimal: 0)

Phone Number

No

Phone Number

text, 255 characters

Postal Code

No

Postal or ZIP Code

text, 255 characters

Referrer

No

The address of the website the user accessed the webcast URL from, if included in the browser header.

text, 255 characters

Registration Date

No

Date of user registration for the webcast

date/time

Sim Live Duration

No

The amount of time the user viewed the webcast in their most recent simulated-live session

int
(length: 18, decimal: 0)

State

No

State or Province

text, 255 characters

Title

No

Job Title

text, 255 characters

Unsubscribed

No

Unsubscribe to email communications for this specific webcast event ID. 

checked(unsubscribed from communications), unchecked(did not unsubscribe from communications)

checkbox (default value: unchecked)

User Agent

No

 A characteristic string that lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.

text, 255 characters

Webcast Event ID

No

Unique id of the corresponding webcast event

text, 255 characters

Webcast Event Title

No

Title of the corresponding webcast event

text, 255 characters

Entity Name: Webcast Survey QA Data

Field Name

Required

Description

Field Type

External ID

Yes

Stores unique values which connect the data between the webcast and Dynamics

text, 255 characters (External ID)

Answer

No

Depending on "Record Type" it is either a viewer's response to a poll/survey or an admin's response to a viewer question

text area, 3000 characters

Campaign Source

No

Track the marketing channel that drove webcast registration

text, 255 characters

Contact

No

Connects the custom object record to the corresponding contact, if contact exists

Contact ID

Email

No

Email

email

Lead

No

Connects the custom object record to the corresponding lead, if lead exists

Lead ID

Question

No

Depending on "Record Type" it is either a viewer question or the question for a poll/survey

text area, 3000 characters

Record Type

No

QA: Is a viewer question

In-Event: Is a survey/poll sent during the webcast

Post-Event: Is a survey responded to after the conclusion of the webcast

text, 255 characters

Webcast Event ID

No

Unique id of the corresponding webcast event

text, 255 characters

Webcast Event Title

No

Title of the corresponding webcast event

text, 255 characters

If you need additional information on creating Custom Entities in Microsoft Dynamics, please contact Dynamics Support.

Implementation Process

To facilitate the integration implementation you will need to schedule a meeting with an integration specialist to review the specific requirements for your integration, which were outlined in the completed form. The integration process is handled almost entirely by the webcast team, there are a couple steps you will need to complete:

  1. Create the two custom entities in Dynamics to store webcast activity data.

 
  1. Connect Workato to Dynamics. It is recommended that the initial integration setup be completed using a sandbox environment, if available. The connection to Workato will be completed during your implementation call, but you can review the process by watching the Workato Connection Setup Tutorial.

Integrations & API Documentation

Reporting API

Introduction

The following documentation reviews the REST API for authenticating and accessing Reporting data on the Webcast platform.

This API require API credentials to be created for your company. These credentials are used to authenticate your account before you can access Webcast report data. To request an API account, please contact Support for assistance.

Authentication

In order to access Webcast reporting data, you must first authenticate using your Webcast API credentials. Below is an exmaple of a Authentication Request. After successful authentication, you will be provided with Session ID and User ID that will be used to access reporting data.

The bold values in this example need to be updated to include your API Username and Password in the corresponding fields. Refer to the example URL and Parameters below for more details. Contact Support to request an API account.

Methods

 

Method Details 

HTTP Methods 

GET 

Content Type 

text/html 

Response Format 

text/xml or text/json

Base Path

XML (default): https://api.webcasts.com/api/login

JSON: https://api.webcasts.com/api/login/json

Parameters

 

Parameter 

Required 

Description 

Format

ver

Yes

API version

Always equal to "2.0"

Alphanumeric, utf-8 

username

Yes 

Reporting admin username 

Ascii email 

password 

Yes 

Reporting admin password

Alphanumeric, utf-8 

The "ver" parameter is always equal to "2.0"

Sample Authentication Request

XML Response Format (Python)

import http.client

conn = http.client.HTTPSConnection("api.webcasts.com")
payload = ''
headers = {
  'Content-Type': 'text/html'
}
conn.request("GET", "/api/login?username=USERNAME&password=PASSWORD&ver=2.0", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

JSON Response Format (Python)

import http.client

conn = http.client.HTTPSConnection("api.webcasts.com")
payload = ''
headers = {
  'Content-Type': 'text/html'
}
conn.request("GET", "/api/login/json?username=USERNAME&password=PASSWORD&ver=2.0", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Event ID List Request

Access a list of all webcast event IDs the admin account has has permission to view. The list will include expired webcasts. The expired status is noted in the response.

Methods

 

Method Details 

HTTP Methods 

GET or POST

Content Type 

text/html 

Response Format 

text/xml, text/json

Base Path

XML (default): https://api.webcasts.com/api/reporting/eventlist

JSON: https://api.webcasts.com/api/reporting/eventlist/json

Parameters

 

Parameter 

Required 

Description 

Format

si

Yes 

user id

Alphanumeric, utf-8

ui

Yes 

session id

Alphanumeric, utf-8 

Sample Event ID List Request


Sample Event ID List Response


Event Report Request

Methods

 

Method Details 

HTTP Methods 

GET or POST

Content Type 

text/html 

Response Format 

text/xml, text/json, or text/csv

Base Path

XML (default): https://api.webcasts.com/api/reporting/audience_reports

JSON: https://api.webcasts.com/api/reporting/audience_reports/json

CSV: https://api.webcasts.com/api/reporting/audience_reports/csv

Parameters

 

Parameter 

Required 

Description 

Format

Accepted Values

ver

Yes

API version

Always equal to "2.0"

Alphanumeric, utf-8 

"2.0"

ui

Yes 

user id

Alphanumeric, utf-8

The user id from authentication

si

Yes 

session id

Alphanumeric, utf-8 

The session id from authentication

ei

Yes

The 7 digit event id of the webcast the report is requested for

Alphanumeric, utf-8 

7 digit webcast id

tz

No

Time Zone for all times displayed in this report. Defaults to GMT if undefined.

Alphanumeric, utf-8 


date_range_start

No

Start date of the report date range. Timestamp is automatically set to 12:00:00 AM on the selected start date.

date

date format mm/dd/yyyy

date_range_end

No

End date of the report date range. Timestamp is automatically set to 11:59:59 PM on the selected end date.

date

date format mm/dd/yyyy

dr_regs


Restricts results by including only registrants who registered within the selected date range. If undefined, it will default to on.

Alphanumeric, utf-8 

"on", "off"

dr_sessions


Restricts results by including only registrants who have viewing duration of any type within the selected date range. If undefined, it will default to on.

Alphanumeric, utf-8 

"on", "off"

sti_filter

No

Restricts results by including only registrants who accessed the event using a URL containing a Campaign Source Tracking Identifier. If undefined, it will default to off. Separate multiple values with pipe delimiter.

Alphanumeric, utf-8 


excl_domain

No

Restricts results by excluding any registrants with emails on the specified domain. If undefined, it will default to off. Separate multiple values with pipe delimiter. Cannot be used with "incl_domain".

Alphanumeric, utf-8 


incl_domain

No

Restricts results by including any registrants with emails on the specified domain. If undefined, it will default to off. Separate multiple values with pipe delimiter. Cannot be used with "excl_domain".

Alphanumeric, utf-8 


users_qa

No

Restricts results by including only registrants who asked a question. If undefined, it will default to off.

Alphanumeric, utf-8 

"on", "off"

user_survey

No

Restricts results by including only registrants who responded to one or more surveys. If undefined, it will default to off.

Alphanumeric, utf-8 

"on", "off"

no_shows

No

Restricts results by including only registrants with no viewing sessions of any type. If undefined, it will default to off.

Alphanumeric, utf-8 

"on", "off"

live_viewers

No

Restricts results by including only registrants with one or more live viewing sessions. If undefined, it will default to off.

Alphanumeric, utf-8 

"on", "off"

od_viewers

No

Restricts results by including only registrants with one or more On-Demand or Archive viewing sessions. If undefined, it will default to off.

Alphanumeric, utf-8 

"on", "off"

simlive_viewers

No

Restricts results by including only registrants with one or more Sim-Live viewing sessions. If undefined, it will default to off.

Alphanumeric, utf-8 

"on", "off"

SAML Documentation

SAML Documentation

Webcast Attendee guide to SAML SSO

SAML Background

Security Assertion Markup Language 2.0 (SAML) is a standard for securely exchanging authentication and authorization data between two parties. The standard is an XML-based protocol that uses security tokens to pass information about an end user between a SAML Identity Provider and a SAML Service Provider.

The GlobalMeet Webcast platform is capable of integrating with any third-party system that supports SAML.


Definitions

“Identity Provider” means the organization responsible for authorizing and authenticating individuals prior to exchanging data with a Service Provider.

“Service Provider” means the organization responsible for validating incoming security tokens, before granting access to a secure Web site.

X.509 certificate” means a digital certificate that uses the international X.509 public key infrastructure (PKI) standard to verify that a public key belongs to the user, computer or organization contained within the certificate.

With respect to this documentation, client systems are considered to be Identity Providers and the GlobalMeet Webcast platform is the Service Provider.

Integration Steps

  1. GlobalMeet Webcast tests SAML integrations on two unique development platforms before enabling on a production environment. The Identity Provider’s internal DevOps team must confirm the number of environments they support internally in order to coordinate development efforts.
  2. The Identify Provider must supply X.509 certificates for each environment to be supported. GlobalMeet Webcast will install these certificates on corresponding systems.
  3. The Identify Provider must supply a SAML XML response file containing the user registration fields to be tracked by the webcast platform. Within the XML these fields are called “attributes”. They contain information about the user, including first name, last name, email or custom information. GlobalMeet Webcast will provide a sample SAML XML response file if needed.
  4. GlobalMeet Webcast will configure a webcast template to map all standard and custom attributes to webcast registration fields. Please note that email is a required field and is used to uniquely identify the user within the webcast.
  5. GlobalMeet Webcast will provide a Response Destination URL. All submissions from the Identity Provider system should be posted to this URL. GlobalMeet Webcast will validate incoming SAML XML responses using the X.509 certificate provided.
  6. If possible, the Identity Provider should supply a way for GlobalMeet Webcast to test the integration using an account authorized by the client SAML system.


Post Data to GlobalMeet Webcast

Below is an example of a simple form post that the Identity Provider can use to submit user data to the Service Provider. Please note that every webcast has a RelayState ID that must be passed within the form post to properly route requests to the correct presentation.   

The items listed in bold are variables:

<html>

<body>

<form method="post" action="GLOBALMEET_WEBCAST_RESPONSE_DESTINATION_URL">

<input name="RelayState" value="EVENT_ID-TP_KEY" />

<input name="SAMLResponse" value="BASE64_ENCODED_SAML_RESPONSE_XML" />

<input type="Submit" name="submit" value="submit" />

</form>

</body>

</html>


RelayState

GlobalMeet Webcast uses RelayState to identify the unique webcast event that user is joining when the Identity Provider is sending user data to GlobalMeet Webcast.  The RelayState is the same as the GlobalMeet webcast Event ID and TP_Key.   You may have 100s or 1000s of webcast and identifying which webcast the view wants to view is an important step.   An example relaystate would look like this “1234567-ab177c1f4e”


SP Initiated or IDP Initiated

You may choose to create a SAML SSO integration where the user initiates their entry from your (Identity Provider) site or the GlobalMeet Webcast URL (SP Initiated.)    Please note that in both cases the XML post will need to include RelayState however with SP Initiated GlobalMeet will send the RelayState to the IDP.


SAML SSO Workflow

image-1673031854675.png


Enabling SAML SSO for Webcast Attendees

Enabling SSO for Webcast Attendees will require that all webcast attendees validate through your corporate SSO or Identity Provider system.  Enabling this feature will restrict any users from joining the event without authenticating properly.  

We support both IdP (Identity Provider) Initiated SSO and SP (Service Provider) Initiated SSO.   When using IdP initiated users will first click on a link provided by the IdP system or some non-webcast related workflow.   When using SP Initiated SSO users will first click on the webcast link to start the SSO workflow.

To Enable IdP-Initiated SSO

  1. Navigate to the security settings page of your webcast.
  2. Under Message for Unauthorized Users, select “Redirect to My Custom Error Page”.
  3. Insert a message to be shown to anyone accessing the webcast directly or who fails IdP login.
  4. Check Require Custom Token
  5. Check Enforce URL Security Key
  6. Provide webcast attendees with the IdP link for login, or other workflow for authentication outside the webcast system.


Troubleshooting and Error Codes

Any user request that cannot be validated will be redirected to an invalid request page.


Typical error codes:

SAML Documentation

Admin App Guide for Okta SAML Integration

Prerequisites AML Background

Users that need to be enabled for SAML login will need an existing account and license on the Webcasts Platform.

 

Supported Features

 

Procedure

  1. From the Okta Integration Network, search and install the "GlobalMeet Webcast Admin" app.
  2. During the setup process, in the "General" settings, if you are using a custom subdomain to login on the Webcasts Admin, enter that value into the "Subdomain" field, otherwise enter "admin" and Save."

    image-1673037895916.png


  3. Next, from the "Sign On" tab, click on Identity Provider metadata below the "View Setup Instructions" button. Copy this and email to your GlobalMeet SAML contact.

    image-1673037949589.png


  4. Once your GlobalMeet SAML contact completes the integration, you will be provided with a "Default Relay State" value. On the "Sign On" tab, enter the provided Relay State value.

    image-1673038784059.png


  5. On the "Application Username Format", select "Email" and save.

    image-1673038866692.png


  6. Done! Now you should be able to login to Webcast Admin platform from the Okta User Dashboard.


References

 

Non-Okta Customers

The workflow is same as Okta; however, setup steps will depend on what platform you are using. From your system we will need the following information or MetaData XML that contains these fields.

Once you provide the above information the configuration will be setup on your GlobalMeet account. We will provide you with a RelayState and Service Provide Consumer URL to complete your SAML SSO setup.   Please note, we currently we only support integration where email is part of the NameID.

 

FAQs

  1. Will 2 Factor Authentication work with SAML SSO? Yes
  2. Do we support Guest logins? No
  3. Do we support Encrypted Assertions? No
  4. What is required information for configuration?

GlobalMeet Subdomain:

Metadata containing following items.

IDP Sign In URL:

IDP Entity Id:

IDP Certificate:

  1. What happens if there are multiple users with same email?

SAML login will fail. SSO only allows a unique email.

  1. What happens if a user’s email is assigned to both an Admin account and Guest Admin account? The user will be logged in with the Admin account.
  2. Reasons why SAML would fail?