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 …