Events

StreamOne logs a great number of Events internally, allowing you to track certain activity, like transcoding activity, changes made to settings, etc. These events are logged to the EventLog (accessible through the StreamOne EventLog API), and it is possible to subscribe to callbacks triggered by the Events using the StreamOne EventHook API.

Event Log

The EventLog is accessible through the management system and the eventlog API. You can search by Event name or within a specified time period.

Receiving EventHooks

Subscribing to EventHooks is done using the EventHook API.

It is possible to add more than one EventHook to an Event, for example to contact a primary and a backup server on your side. The callbacks will be sent using HTTP POST. If your server returns a HTTP/200 response, we will consider the event as sent. If your server refuses the connection or returns an error code (e.g. HTTP/500 or HTTP/404), our system will keep trying. Retries are rate-limited; the first retry is almost immediate, the second one after one minute, then five, fifteen, sixty, etc.

The following information is sent as key-value pairs using HTTP POST:

  • apiaccountid (the API Account ID)
  • apiuserid (the API User ID, if applicable, explaining which user deleted an item, for example)
  • eventname (the Event Name, like described in the table below)
  • Event specific variables, see Event Variables in the table below

All the information sent is case-sensitive. All keys are sent in lower case.

Overview of Events

In the following table, you will find a complete overviews of all Events available within StreamOne at this time. Note that events might require a user to have a specific token.

Event Name Event Description Event Description Required Token
account-create Created new account accountid none
account-delete Deleted account accountid none
account-edit Edited account accountid none
accountdrm-create Account DRM creation issued id, accountid, streamtype none
accountdrm-delete Account DRM deletion issued id, accountid, streamtype none
accountdrm-update Account DRM update issued id, accountid, streamtype none
application-create Application created applicationid none
application-delete Application deleted applicationid none
application-edit Application edited applicationid none
callback-create Callback created accountid, hookid, hookactionid, target none
callback-delete Callback deleted accountid, hookid, hookactionid none
category-create Category created categoryid none
category-delete Category deleted categoryid none
category-deleted Category deleted categoryid none
category-edit Category edited categoryid none
category-removemetavalue Category metavalue removed categoryid, metakeyid none
category-setmetavalue Category metavalue set categoryid, metakeyid, metavalue, metaweight none
clientgroup-create A client group has been created clientgroupid none
clientgroup-delete A client group has been deleted clientgroupid none
clientgroup-update A client group has been updated clientgroupid none
custom-event Custom event, meant for use by external applications and testing input = output, see Event documentation none
customer-create Customer created customerid none
customer-delete Customer deleted customerid none
customer-edit Customer edit customerid none
eventhook-add EventHook Added accountid, eventhookid, eventid, eventtypeid, target none
eventhook-remove EventHook Removed accountid, eventhookid none
eventhook-update EventHook Updated accountid, eventhookid, eventid, eventtypeid, target none
exportjob-completed Exportjob Completed itemid, itemfileid, exportprofileid, exportjobid none
exportjob-create Exportjob Created accountid, exportjobid, exportprofileid, itemid, fileid none
exportjob-delete Exportjob Delete accountid, exportjobid none
exportjob-edit Exportjob Edited accountid, exportjobid, exportprofileid, itemid, fileid none
exportjob-failed Exportjob Failed itemid, itemfileid, exportprofileid, exportjobid none
exportjob-started Exportjob Started itemid, itemfileid, exportprofileid, exportjobid none
exportprofile-create Exportprofile Created accountid, exportprofileid none
exportprofile-delete Exportprofile Deleted accountid, exportprofileid none
exportprofile-edit Exportprofile Edited accountid, exportprofileid none
file-delete A file has been deleted file file-delete
ftp-user-create A new FTP user has been created accountid, username none
ftp-user-delete A FTP user has been deleted accountid, username none
ftp-user-edit A FTP user has been edited accountid, username none
importjob-completed Import Job Completed importjobid none
importjob-create Importjob Created accountid, importjobid, importtypeid, source none
importjob-delete Importjob Delete accountid, importjobid none
importjob-edit Importjob Edited accountid, importjobid, importtypeid, source none
importjob-failed Import Job Failed importjobid none
importjob-started Import Job Started importjobid none
item-addtocategory Add item to category itemid, categoryid none
item-create New Item created jobid, itemid none
item-createuploadtoken Create uploadtoken uploadtoken, uploadurl, itemid none
item-delete Item deleted itemid none
item-edit Item edited itemid none
item-ingest-failed Ingesting an item failed filename, uploadtoken none
item-ingest-file-corrupt A ingested file is corrupt filename, item, file, reason none
item-ingest-xml-fail Failed to parse XML file for Item Ingest   none
item-poster-updated The poster information for an item has been updated itemid none
item-removefromcategory Remove item from category itemid, categoryid none
item-replace-complete Finished replacing the files in this item accountid, itemid, itemfileid, externalitemid none
item-replace-error Replacing an item failed item, reason none
item-replace-start Replacing an item has started item none
item-transcode-all-complete Finished transcoding all files for this item accountid, itemid, itemfileid, externalitemid, profileid, profilename none
item-transcode-complete Finished transcoding a file for this item accountid, itemid, itemfileid, externalitemid, profileid, profilename, jobid, targetitemfileid none
item-transcode-fail Failed transcoding a file for this item accountid, itemid, itemfileid, externalitemid, profileid, profilename, jobid none
item-transcode-start Started transcoding a file for this item accountid, itemid, itemfileid, externalitemid, profileid, profilename, jobbid none
item-undelete Item undeleted itemid none
itemfile-add Add itemfile itemid, itemfileid none
itemfile-delete Delete itemfile itemid, itemfileid none
itemfile-edit Edit itemfile itemid, itemfileid none
job-addfiles Output files added to job jobid none
job-cancel Job canceled jobid, reason none
job-complete Job completed jobid none
job-create Job created jobid none
job-fail Job failed jobid, reason none
job-pause Job paused jobid none
job-resume Job resumed jobid none
job-softfail Job softfailed jobid, reason none
job-start Job started jobid none
live-proxy-down Livestream Ingest through proxy server ended accountid, livestreamid none
live-proxy-up Starting Livestream Ingest through proxy server accountid, livestreamid none
livestream-create Livestream created accountid, livestreamid none
livestream-delete Livestream deleted accountid, livestreamid none
livestream-down Livestream has gone down accountid, livestreamid none
livestream-edit Livestream edited accountid, livestreamid none
livestream-publish Livestream publish notification issued accountid, livestreamid none
livestream-reset Livestream reset command issued accountid, livestreamid none
livestream-restart Livestream restart command issued accountid, livestreamid none
livestream-start Livestream start command issued accountid, livestreamid none
livestream-stop Livestream stop command issued accountid, livestreamid none
livestream-unpublish Livestream unpublish notification issued accountid, livestreamid none
livestream-up Livestream has come online accountid, livestreamid none
livetask-cancel Live task canceled livetaskid none
livetask-complete Live task completed livetaskid none
livetask-fail Live task failed livetaskid, reason none
livetask-pause Live task paused livetaskid none
livetask-start Live task started livetaskid none
livetask-wait Live task waiting to start livetaskid none
platform-server-shutdown StreamOne Server Shutting Down serverid none
platform-server-start StreamOne Server Starting Up serverid none
platformstorage-addmount Mount added to platform serverid, storagename, devicename, localmount, available none
platformstorage-editmount Platform mount edited serverid, storagename, devicename, localmount, available none
platformstorage-removemount Platform mount removed serverid, storagename, devicename, localmount, available none
player-create Player created accountid, playerid none
player-delete Player deleted accountid, playerid none
player-edit Player edited accountid, playerid none
playerplugin-create Player plugin created playerpluginid none
playerplugin-delete Player plugin deleted playerpluginid none
playerplugin-edit Player plugin edited playerpluginid none
playerskin-create Player skin created playerskinid none
playerskin-delete Player skin deleted playerskinid none
playerskin-edit Player skin edited playerskinid none
playlist-additem Playlist item added accountid, playlistid, itemid none
playlist-create Playlist created accountid, playlistid none
playlist-delete Playlist deleted accountid, playlistid none
playlist-edit Playlist edited accountid, playlistid none
playlist-edititem Playlist item edited (only position known, skippability toggled) accountid, playlistid, position none
playlist-moveitem Playlist item moved (only position known) accountid, playlistid, position, newposition none
playlist-removeitem Playlist item removed (only position known) accountid, playlistid, position none
profile-create Create transcode profile profileid none
profile-delete Delete transcode profile profileid none
profile-edit Edit transcode profile profileid none
profile-group-add Add profile to transcode profile group profilegroupid, profileid none
profile-group-create Create transcode profile group profilegroupid none
profile-group-delete Delete transcode profile group profilegroupid none
profile-group-edit Edit transcode profile group profilegroupid none
profile-group-remove Remove profile from transcode profile group profilegroupid, profileid none
profile-group-setgroupdefault Set profile as default in transcode profile group profilegroupid, profileid none
recording-adhocedit Edited adhoc recording accountid, recordingid, adhocduration none
recording-create Created recording accountid, recordingids (array) none
recording-delete Deleted recording accountid, recordingid none
recording-delete-series Deleted recording series (recordingid represents an ID of one of the recordings) accountid, recordingid none
recordschedule-create A record schedule has been created recordscheduleid none
recordschedule-delete A record schedule has been deleted recordscheduleid none
recordschedule-update A record schedule has been updated recordscheduleid none
recordtask-complete Recordjob processing completed recordjobid none
recordtask-create A record job has been created jobid none
recordtask-update A record job has been update jobid none
role-addtoken Add Token to Role roleid, tokenid none
role-create Role created roleid, rolename none
role-delete Role deleted roleid none
role-edit Role edited roleid, rolename none
role-removetoken Remove Token from Role roleid, tokenid none
schedule-queue A schedule has been queued as a live tasmk scheduleid none
security-addrule Add security rule to profile securityprofileid, slot none
security-create Create security profile securityprofileid, securityprofilename none
security-delete Delete security profile securityprofileid none
security-edit Edit security profile securityprofileid, securityprofilename none
security-editrule Edit security rule in profile securityprofileid, slot none
security-removerule Remove security rule from profile securityprofileid, slot none
security-swaprules Swap security rules in profile securityprofileid, slot, newslot none
server-create A server has been created serverid none
server-delete A server has been deleted serverid none
server-edit A server has been edited serverid none
server-role-add A role has been added to a server serverid, serverrole none
server-role-edit A role has been edited on a server serverid, serverrole none
server-role-remove A role has been removed from a server serverid, serverrole none
slideshow-cancel Slideshow processing canceled slideshowid, reason none
slideshow-complete Slideshow processing completed slideshowid, itemid none
slideshow-create Slideshow created slideshowid none
slideshow-createtaggle Taggle slideshow created   none
slideshow-delete Slideshow deleted   none
slideshow-fail Slideshow processing failed slideshowid, reason none
slideshow-pause Slideshow processing paused slideshowid none
slideshow-resume Slideshow processing resumed slideshowid none
slideshow-start Slideshow processing started slideshowid none
transcodejob-create Created transcode job transcodejobid, profileid, deletesource none
transcodejob-delete Delete transcode job transcodejobid none
transcodejob-setpriority Reprioritized transcode job transcodejobid, newpriority none
user-add-role Adding role to user userid, roleid, accountid none
user-create Creating user userid, username none
user-delete Deleting user userid none
user-edit Editing user userid none
user-key-change Changing user key userid none
user-password-change-create-failed Changing password change request for user failed userid, username, reason none
user-password-change-finished Password change request for user finished userid, username, sessiontoken none
user-password-change-initialize Created password change request for user userid, username, sessionchallenge none
user-remove-role Removing role from user userid, roleid, accountid none
user-resetpass-process Processing reset pass resetkey none
user-resetpass-request Requesting reset pass resetkey, username none
user-session-create Created session for user userid, username, sessiontoken none
user-session-create-failed Creating session for user failed userid, username, reason none
user-session-initialize Initialized session for user userid, username, sessionchallenge none
user-uploader-create Creating ftp uploader for user username, ip none
user-uploader-delete Deleting ftp uploader for user username, ip none
user-uploader-edit Editing ftp uploader for user username, ip none
worker-update A worker has been updated workerid none