Direct APIs

Single Sign On (SSO) Registration API Guide

Introduction

The following document reviews the Single Sign On (SSO) Registration API for the Webcast platform. This API is used to seamlessly pass audience members from a client or 3rd party registration systems to the Webcast event. The process allows an external registration form to register audience members and forward them to the Webcast by directing them to a customized Single Sign On URL via https GET or POST.

This is an Open API, allowing for setup and testing at your convenience. If you have any questions on the setup, please contact Support for assistance.

Setup

This API allows an external registration form to register audience members and forward them to the Webcast by directing them to a customized Single Sign On URL via https GET or POST.

Below is an exmaple of the Single Sign On (SSO) Registration URL. The bold values in this example need to be updated to include the audience member's registration information.

This example will include all optional registration fields that can be passed to an event. Parameters can be removed from the URL to only pass certain fields. Refer to the table below for a list of required and optional fields.

Sample Single Sign On (SSO) Registration URL

https://event.webcasts.com/starthere.jsp?ei=1234567&tp_key=ab123c4567&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

Parameter Description Values Character Limit
ei*
Event ID
(Ex. 1234567)
Number
7
tp_key*
Event Key
(Ex. ab123c4567)
Alphanumeric, utf-8
10
fname
First Name
Alphanumeric, utf-8
256
lname
Last Name
Alphanumeric, utf-8
256
company
Company Name
Alphanumeric, utf-8
256
title
Business Title
Alphanumeric, utf-8
256
address1
Street Address
Alphanumeric, utf-8
256
address2
Street Address - Extra
Alphanumeric, utf-8
256
city
City
Alphanumeric, utf-8
256
state
State
Alphanumeric, utf-8
256
country
Country
Alphanumeric, utf-8
256
postalcode
Postal/Zip Code
Alphanumeric, utf-8
256
phone
Primary Phone Number
Alphanumeric, utf-8
256
cell
Cell/Mobile Number
Alphanumeric, utf-8
256
fax
Fax Number
Alphanumeric, utf-8
256
email*
Email Address
Ascii email
128
custom_question1
Custom Registration Question Answer
Alphanumeric, utf-8
256

Notes:

Test the Setup

Once you have submitted a registration, any data should immediately appear in the Webcast reports. Follow the steps below to confirm the data was received in your event's reports.

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

Server Side Registration


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.

Server Side Registration


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.