Webhooks Developer Guide

Carles Galan API, Webhooks

Overview Webhooks allow you to collect information about events as they happen in near real-time. Provide a URL, select when and where you want that URL to receive data about events on your list, and we’ll send it to you as the events take place. For general reading on Webhooks, read the PBWiki Webhooks page. To test our Webhooks before setting up scripts, the RequestBin tool is an excellent utility that helps you see data come across as various events happen in our system. Configuring Webhooks Webhooks are configured from your webcaStudio workspace. There are two possible levels, Workspace-level webhooks and Event-level webhooks. Creating Workspace-level Webhooks Account-level webhooks are a collection of events triggered when certain actions happen in your workspace. Log in to your workspace console Navigate to Settings Click Workspace on left side menu Click Webhooks Click Add new webhook button Creating Event-level Webhooks Event-level webhooks are triggers dispatched when some actions happen in certain webcaStudio’ event. Log in to your workspace console Create a new Event or Edit an existing one Go to Webhooks tab Click Add new webhook button Mapping Mapping feature allows you to configure how the data will arrive to your service. It specially useful when you want to use a generic service for different purposes. Webhooks types Webcastudio webhooks will send an object representing the entity in webcastudio which was affected by the action triggered. These are the possible webhook types: Event-type Describes the Event entity. Property Type Description event_id Number Event ID account_id Number Workspace ID event_name String Event title event_description String Event description event_status String Event status category. Possible values: “live_pending” (green color in console), “od_pending” (blue color), “od_publisehd” (orange color). event_start_date String Event starting date event_finish_date String Event finishing date event_languages Array of Objects Event languages   id Number Language ID   name String Language short code (e.g. ‘en’, ‘ca’)   label String Language description Session-type Describes the Session entity. A Session represent a webcast session within an Event. Property Type Description session_id Number Event session ID event_id Number Event ID account_id Number Workspace ID session_name String Session name session_start_datetime String Session starting time (including date) session_finish_datetime String Session finishing time (including date) template_id Number Player template ID app_version String Player version session_live_status String Session LIVE status. Possible values: off: Session is offline live_publishing: Session is ready to go live but Audience is not allowed to access yet live_open: Session is live and Audience may …

Google Analytics in webcaStudio

Carles Galan API, Stats Leave a Comment

This post covers the usage of Google Analytics with webcaStudio workspaces and events. Requirements Access to a webcaStudio workspace administration account as Super-Administrator user. A Google Analytics account. Step 1: Create a Google Analytics Account In order to start tracking the audience of your webcaStudio’s events with Google Analytics you first need to create a new Google Analytics Account. Sign in Google Analytics dashboard (https://www.google.com/analytics/) and go to Admin section, then deploy ACCOUNT combobox and click on “Create new account”. The important field in this page is Website URL. Its value has to be your webcaStudio domain name, for example, vancast.webcasting-studio.net. You also should pay attention on which protocol you choose. Since webcaStudio’s console gives secure URLS by default, choose https:// as Website URL protocol. But if you will deliver no-secure URL to your audience you have to select the option http://. Click on Get Tracking ID button and accept terms. You will end up on a page that shows your new Tracking ID. Copy it, you will need it later. Step 2: Create a new Track-ID for your webcaStudio workspace Once you have obtained a Tracking ID you need to associate it to your workspace. Sign in your webcaStudio console and go to Settings. In the left menu deploy Workspace settings and open Google Analytics section. Since your workspace may have more than one Track-ID configured, you can give it a name to identify the Track ID later. Copy the Tracking ID obtained from Google Analytics Console and press Add. Additionally, you can set a Track ID as default. The default Track ID will be associated automatically to the new events. Step 3: Associate a Track-ID with an Event Google Analytics will not track your audience until you associate one of your Track-ID with your event. Open your Event’s preferences pressing Edit button. Go to Integration tab and deploy Google Analytics section. Select a Track-ID and click on Save button. If there was a default Track ID when you created your event it will have a Track ID associated already. Now your Audience will be tracked by Google Analytics. NOTE: Configuring Google Analytics does not disable the standard webcaStudio stats system. Stop tracking with Google Analytics If you don’t want Google Analytics track your audience any more you can disassociate a Track ID selecting ‘None’ option in the Integration tab.

How to configure a MailChimp campaing for a webcaStudio webinar

Carles Galan API, SSO Leave a Comment

This tutorial explains how to create a MailChimp campaign to invite your subscriber to assist to a webcaStudio webinar passing along webcaStudio all the subscribers data. Requirements We suppose you already have experience using both platforms MailChimp and webcaStudio. A webcaStudio account with Super permissions. A PSK created for your workspace Step 1. Add a MailChimp API Key to your workspace. First of all, you need to configure your workspace to be able to access your MailChimp data. Go to your MailChimp dasboard Click on Account > Extras > API keys Create a new Key Copy API Key value Got to your webcaStudio workspace Click on Settings > MailChimp API Keys Give it a name to remember which account is for Paste the API Key and press Add You can create any Keys you need and even use several MailChimp accounts for the same webcaStudio workspace. Step 2. Create a MailChimp List. WebcaStudio will retrieve user information from a MailChimp list. User object in webcaStudio has 4 fields: Email, first name, last name and organization. Your MailChimp list must have at least this 4 fields (not necessary with these labels). If you want to use an existing list go directly to step 4. Go to your MailChimp dashboard Click on Lists > Create List Fill list information Click on Settings > List fields Make sure your list has at least 4 fields. They usually are: Email, first name, last name, organization or company. Add or import subscribers Step 3. Configure MailChimp for your event Access your event’s Edit page. Got to the Integration Tab Open the MailChimp panel Select one of your MailChimp Keys Complete the data mapping for the list you want to integrate with. For instance, if your list uses the label Company instead of Organization, replace the ORG tag by COMPANY. Save your changes Step 3. Create a MailChimp campaign Open your MailChimp dashboard Click on Campaigns > Create Campaign Select a campaign type Select a list or segment Complete the campaign details Select an email template In Design view, drag and drop a button element Leave “Web address” option selected Place one of the URLs webcaStudio generated in MailChimp integration panel. WebcaStudio will generate two types of URLs: Event Program URL: This URL will drive your audience to the Event Program page. Session URL: With Session URL users will access directly to a session. All URLs will be replicated for each event’s …

Embedding webcaStudio player in a web page

Frank Carmona API, SSO Leave a Comment

Introduccion the tag <iframe>  </iframe> is perhaps one of the simplest and most compatible ways of integrating a player within your webpage. This Post covers the integration for any of the access systems in webcaStudio Open free and open free registered Embeding the open free acces URL’s is the simplest way to do it as it requires no programing . Altough you can embed the whole programe page, the recommended way is to embed the session URL’s. To do this, click on the session links to get the session URL’s for any of these acccess systems. Depending on the player Template chosen for this session, dimensions may be different. Observe that dimensions are specified next to each session’s name. In above’s example dimensions are 1018px width and 670px height. The iframe code is built as follows: In case you want to use the Open Access-Registration Required access mode, the iframe will show up the login page as well. Remember that the aspect of the different pages can be personalized within the “Program” tab From this point ahead the event cycle live behavior is the same as when you use the URL’s directly within a browser; If the event is not live yet, a landing page with a disabled access button will appear. If the user waits with this page opened, the access button will enable itself automatically as soon as the producer gives the appropriate order either publish live or on-demand When an event is opened in live or on-demand mode, any user trying to access the event will open it directly in the page where the event session is embedded Single Sign On In this case you can not use directly the session’s URL’s as webcaStudio receives user data and URL’s via POST and an iframe works as an embedded window within another, so the browser will use GET for this call. In order to embed a session’s player using the SSO you must build a small piece of code, “middleware”, which essentially will gather the user info and together with a PSK “Pre-Shared-Key” and some other information make a unique encrypted call to webcaStudio platform. The player will build the same hash to check whether the call is valid or not. A PHP middleware sample follows   Finaly, we specify the URL to the middleware program within the iframe: User/Password Validation Lists The system works the same way …

Secure Single Sign-On Developer Guide

Frank Carmona SSO

SUMMARY This document explains the Secure Single Sign On (SSO) application for end-users access to webcaStudio platform  live or on-demand contents Definitions and conventions: Master Account:  Company that has a current webcaStudio platform subscription Workspace: Independent space intended to allow the master account holder to enable a separate and thus confidential space for a customer webcaStudio: Software as a service platform by means of which an organization can manage and publish Rich Media live or on-demand presentations addressed to a large number of end users who will be able to access and participate to a high quality professional on-line presentation. Secure Access: Many times the contents produced by the Customer and served by webcaStudio platform are highly confidential and / or have a high economic value.  The “Secure SSO”  allows you to integrate your  “Internal Client Platform” with webcaStudio Internal Client Platform: by this we refer to your or your customer’s, intranet, employee portal, e-learning platform, on-line event login platform, etc. owned by the Customer which already includes authentication features.   The Secure SSO application is the ideal choice for those who want to enable convenient and secure Access to any live or on-demand  webcasStudio  based contents from their own secured pages. It is also the right choice for those organizations that want to distribute on-line conferences and already have their own event registration and secure online payment processing systems And, of course, to anyone that wants to avoid users to login more than one time to seamlessly navigate through different platform solutions integrated as one. The system is based in the following premises: Authentication by the Customer: User Authentication is solved by the Customer platform, in other words, the intranet, e-learning or on-line conference clearance system. SSO (Single Sign On): Once an end user has been logged to the Customer platform, he will no longer need to re-log in to the webcaStudio environment. Secure Access: webcaStudio will check the user correct login from the Customer platform and will block any non-authorized user login attempt to access the contents.   IMPLEMENTATION  The technical solution we provide needs the Customer to develop a simple “Access Application Module”. This application shall be based on the following concepts: Connection URL: Each group of contents that make up an “event” within the webcaStudio platform is represented by a URL. Language code: An Event can be broadcasted in different languages simultaneously. The Access Application Module can send the language …