Webinar API

After you’ve created a webinar in Clevercast, you can use its unique ID (string) to add registrants through API calls. This way, you can handle the registration process yourself.

There’s also an API call to check if a webinar registrant exists and retrieve her data, based on the webinar ID and registrant email (= part of the API request).

All API endpoint paths are relative to https://{account}.clevercast.com/api/v1/webinar/

The API calls require Basic Authentication, using the email/password of a Clevercast user account with the necessary permissions.

The HTTP POST requests must contain a json object in the request body, and therefore require the ‘Content-Type: application/json’ HTTP header to be set.

If the HTTP POST request succeeds, the response will have a ‘200: OK’ HTTP status code and contain a json object in its body.

If the HTTP POST request fails, the response will have a 400+ or 500+ status code and a json object in its body. For more information about the error, you can retrieve the ‘error’ string from the json object.

Create Registrant

The API call is made by sending a HTTP POST request to https://{account}.clevercast.com/api/v1/webinar/create-registrant/

When the API call succeeds, it returns the unique secret that provides the user with initial access to the webinar. Add it to the ‘r’ variable of the query-string of your webinar page: https://{account}.clevercast.com/webcast/{webinar-id}/?r={secret}

Details

POST https://{account}.clevercast.com/api/v1/webinar/create-registrant/

Overview

This API call sends the email address, first and last name of a user to Clevercast in order to get access to a webinar (identified by the webinar ID).

Clevercast will do the following:

If no registered user (= registrant) with the given email exists, a new registrant is created (= giving the new user access to the webinar)
If a registrant with the given email already exists, his first and last name are updated

Request

The request should contain the following json structure in its body:

{
  "email": string,
  "webinar": string,
  "first_name": string,
  "last_name": string,
  "approve": boolean,
  "send_email": boolean
}

Properties
email	string (required) The email address of the user to be created or updated.
webinar	string (required) The ID that Clevercast uses to uniquely identify the webinar to which the user is given access.
first_name	string (required) First name of the user.
last_name	string (required) Last name of the user.
approve	boolean (optional, default = true) Automatically approve the registered user. If set to false, the registrant still has to be approved by an administrator after being created.
send_email	boolean (optional, default = true) Send an email to new registrants, if this is set in your webinar’s configuration. If set to false, no email will be sent by Clevercast.

Response

If the request succeeds, the 200 response will contain the following json structure in its body:

{
  "secret": string,
  "exists": boolean
}

Properties
secret	string A unique code that must be added to the query-string of the webinar URL for initial access to the webinar.
exists	boolean Will be set to false if a new user has been created. If the user already exists, it is set to true.

Error Response

If the request fails, the 400+ response will contain the following json structure in its body:

{
  "error": string
}

Properties
error	string Description of the error that caused the API call to fail.

Get Registrant

The API call is made by sending a HTTP POST request to https://{account}.clevercast.com/api/v1/webinar/get-registrant/

When the API call succeeds, it returns a response that lets you determine whether the registrant with a certain email address exists for a given webinar. If the registrant exists, the response also contains the registrant’s unique secret (= provides the user with initial access to the webinar), her first and last name, and approval status.