WebinarFuel API Documentation

Introduction

Welcome to the WebinarFuel API!

Authentication

The WebinarFuel API uses HTTP Token to authenticate requests. You need to include your API key(Settings->API section) in the Authorization header with the Bearer authentication scheme: 'Authorization: Bearer {{API_KEY}}'.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Error Codes

200 OK - the request was successful (some API calls may return 201 instead).
201 Created - the request was successful and a resource was created.
204 No Content - the request was successful but there is no representation to return (i.e. the response is empty).
400 Bad Request - the request could not be understood or was missing required parameters.
401 Unauthorized - authentication failed or user doesn't have permissions for requested operation.
403 Forbidden - access denied.
404 Not Found - resource was not found.
405 Method Not Allowed - requested method is not supported for resource.
429 Too Many Requests - request rate limit has been reached in a given amount of time.

Rate Limits

To preserve the integrity and reliability of the platform, our APIs have the following rate limits.

The guaranteed rate limit for common APIs is 100 requests/minute unless otherwise noted below.

When your application hits the rate limit, the API will return an API response with a HTTP status code of 429 Too Many Requests.

The response will include the following headers:

RateLimit-Limit: 100,
RateLimit-Reset: 1585093034,
Retry-After: 34

RateLimit-Limit - current limit of an endpoint.
RateLimit-Reset - timestamp which provides guidance on when the API call can be retried.
Retry-After - amount of time(in seconds) after which the API call can be retried.

Reference

Webinar

Webinar attributes:

id (Number) : Unique identifier.
name (String) : Name.
description (String) : Description.
time_zone (String) : TimeZone name.
sessions (Array): List of sessions.
- id (Number) : Unique session identifier.
- scheduled_at (String) : Timestamp in ISO8601 format. Only exists for one time sessions and recurring sessions with exact_recurring_dates flag.
- formatted_scheduled_at (String) : Readable scheduled datetime formatted to provided time_zone or to webinar time_zone by default.
hosts (Array): List of hosts.
- email (String) : Email.
- first_name (String) : First name.
- last_name (String) : Last name.
- bio (String) : Bio.
- organizer (Boolean) : Webinar organizer.
- avatar_url (String) : Avatar url.

Webinars Collection

A Collection of webinars.

Retrieve all Webinars

Retrieve all webinars with ready state. Returns a hash with webinars and meta properties. webinars property contains an array of up to per_page webinars with ready state. Each entry in the array is a separate Webinar object. If no other webinars are available, the resulting array is empty.meta property contains a hash with page, per_page, total_items and total_pages properties.

URI Parameters
sessions_limit	Number of sessions. Maximum number = 50.
exact_recurring_dates	Exact dates for recurring sessions.
time_zone	TimeZone name in which formatted_scheduled_at will be converted. If not provided webinar timezone will be used.
page	Page number of the results to fetch.
per_page	The number of results per page (max 50).

Webinar

A single Webinar object with all its details

URI Parameters
id	Numeric `id` of the Webinar to perform action with.
sessions_limit	Number of sessions. Maximum number = 50.
exact_recurring_dates	Exact dates for recurring sessions.
time_zone	TimeZone name in which formatted_scheduled_at will be converted. If not provided webinar timezone will be used.

Retrieve a Webinar

Returns a specific Webinar with ready state.

Registrant

Registrants Collection

A Collection of registrants.

Retrieve all Registrants

Retrieve all registrants. Returns a hash with registrants and meta properties. registrants property contains an array of up to per_page registrants. Each entry in the array is a separate Registrant object. If no other sessions are available, the resulting array is empty. meta property contains a hash with page, per_page, total_items and total_pages properties.

URI Parameters
email	A case-sensitive filter on the list based on the registrant's `email` field.
page	Page number of the results to fetch.
per_page	The number of results per page (max 50).

Create Registrant

To create a new Registrant simply provide a JSON hash of the webinar_id and registrant attributes with correct webinar_session_id and scheduled_at. You can get these parameters via Webinars.
If a registrant already exists, his attributes will be updated.

200

Request

object

webinar_id
Webinar to which you want add a Registrant. Webinar must be fully configured and in ready state.
number, required
registrant
object
session
object

Registrant

A single Registrant object with all its details

URI Parameters
id	Numeric `id` of the Registrant to perform action with.

Retrieve a Registrant

Returns a specific Registrant.

Update a Registrant

Updates a specific Registrant.

Request

object

registrant
object

Add Tags

Add tags to Registrant

To add tags to an existing registrant simply provide email and list of tags that must be added.

200

Request

object

email
Registrant Email.
string, required
tags
Tags list.
array, required

Remove Tags

Remove tags from Registrant

To remove tags from an existing registrant simply provide email and list of tags that must be removed.

200

Request

object

email
Registrant Email.
string, required
tags
Tags list.
array, required

OneClick

This endpoint does not require an Authorization header. Instead, you need to provide your webinar's oneclick key(Webinar -> Settings -> OneClick Registration).

Create a Registrant via OneClick

To create a new Registrant simply provide a webinar_id and registrant attributes with correct webinar_session_id and scheduled_at. You can get these parameters via Webinars.
If a registrant already exists, his attributes will be updated. After successfull creation redirects to webinar's thank you page if its configured.

URI Parameters
oneclick_key	Webinar's oneclick key(Webinar -> Settings -> OneClick Registration).
email	Registrant Email.
first_name	Registrant First name.
last_name	Registrant Last name.
phone	Registrant phone.
tags	Tags list. Correct format: ?tags[]=first_tag&tags[]=second_tag.
custom_fields	Custom Fields. Correct format: ?custom_fields[Do you like webinars]=Yes&custom_fields[Hello]=World.
webinar_session_id	Webinar Session to which you want add a Registrant.
scheduled_at	`Only for recurring sessions`. You can define the specific timestamp in ISO8601 format. If you do not provide this attribute, it will use the next possible time.
time_zone	Session TimeZone name. Required if webinar timezone is 'registrant'.
ip	Session IP address.
referrer	Session Referrer.
source	Session Source.
utm_source	UTM Source.
utm_medium	UTM Medium.
utm_campaign	UTM Campaign.
utm_term	UTM Term.
utm_content	UTM Content.

Registrant Sessions

Registrant Session attributes:

cid (Number) : Session CID.
webinar_id (Number) : Webinar ID.
webinar_session_id (Number) : Webinar Session ID.
registrant_id (Number) : Registrant ID.
scheduled_at (String) : Scheduled At time in iso8601 format.
scheduled_at_in_time_zone (String) : Scheduled At time in time zone in iso8601 format. If webinar time_zone is "registrant" viewer session time zone will be used. If viewer session time zone is empty UTC time zone will be used. If webinar time_zone is not "registrant" webinar time zone will be used. If webinar time zone is empty account time zone will be used.
canceled (Boolean) : Determines if the session has been canceled.
join_url (String) : Url to join session.
replay_url (String) : Url to join replay of the session.
encore_url (String) : Url to join encore of the session.
calendar_urls (Object) : List of calendar urls.
- ics (String) : ICS calendar url.
- google (String) : Google calendar url.
- vcs (String) : VCS calendar url.
source (String) : Source.
referrer (String) : Referrer.
utm_source (String) : UTM source.
utm_term (String) : UTM term.
utm_campaign (String) : UTM campaign.
utm_medium (String) : UTM medium.
utm_content (String) : UTM content.
time_zone (String) : Time Zone.
province (String) : Province.
country (String) : Country.
country (String) : Country.
city (String) : City.
os (String) : Operational System.
browser (String) : Browser.
device (String) : Device.
attended (Boolean) : Determines if the session has been attended.
attended_time (Number) : Attended time in seconds.
watched (Boolean) : Determines if the session has been fully watched.

Registrant Sessions Collection

A Collection of registrant sessions.

Retrieve all Registrant Sessions

Retrieve all registrant sessions. Returns a hash with sessions and meta properties. sessions property contains an array of up to per_page sessions. Each entry in the array is a separate Session object. If no other sessions are available, the resulting array is empty. meta property contains a hash with page, per_page, total_items and total_pages properties.

URI Parameters
webinar_id	A filter on the list based on the object `webinar_id` field. Webinar must be fully configured and in ready state.
webinar_session_id	A filter on the list based on the object `webinar_session_id` field.
email	A case-sensitive filter on the list based on the registrant's `email` field.
before_scheduled_at	Only sessions before or equal to this `scheduled_at` date will be returned. The value must be provided in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
after_scheduled_at	Only sessions after or equal to this `scheduled_at` date will be returned. The value must be provided in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
page	Page number of the results to fetch.
per_page	The number of results per page (max 50).

Registrant Session

A single Reginstrant Session object with all its details

URI Parameters
cid	Registrant Session `cid` value to perform action with.

Retrieve a Registrant Session

Returns a Registrant Session.