Skip to main content

Webhooks (triggers) for monitoring

Webhooks are an automation method within MistServer. Their introduction is available at webhooks introduction. While notification hooks/triggers are meant specifically for monitoring tasks the life cycle hooks/triggers can be used for he same purpose. Though typically you will want to undertake some form of action when a life cycle hook/trigger fires.

A full list of hooks/triggers and how they work can be found at the hooks/triggers documentation

Notification Hook/triggers​

These exist purely to pass on information to another application/endpoint meant to measure, list or log so decisions can be made or logged. These cannot activate a response to the trigger itself and are only there for logging purposes.

  • CONN_CLOSE - ( Whenever a connection closes)
  • INPUT_ABORT - ( Whenever an input process exists with error)
  • LIVEPEER_SEGMENT_REJECTED - ( Whenever a segmented is rejected by MistProcLivepeer with a 422 status twice in a row for different broadcasters)
  • LIVE_TRACK_LIST - ( Whenever valid tracks update/change)
  • OUTPUT_END - ( Whenever an output (push or pull out) stops)
  • OUTPUT_START - ( Whenever an output to another server starts)
  • OUTPUT_STOP - ( When a protocol connector stops listening for connections)
  • PUSH_END - ( Whenever a push (file or target) stops for any reason)
  • RECORDING_END ( Whenever a push to file finishes)
  • STREAM_BUFFER ( Whenever a live stream buffer changes)
  • STREAM_END ( Whenever a stream ends due to viewer inactivity)
  • USER_END ( Whenever a session ends, give statistics of session)

Lifecycle Hook/Triggers​

These exist to start/continue/stop new or existing connections.

  • CONN_OPEN - (Whenever a connection is accepted, false blocks)
  • CONN_PLAY - (Right before playback after acception, false rejects)
  • LIVE_BANDWIDTH - (Everytime keyframe is received, check bandwidth, if false shut down input)
  • STREAM_PUSH - (Right before an incoming push is accepted, false to reject the push)
  • STREAM_READY - (When a stream finished loading and is ready for playback, if false shut down the input)
  • STREAM_UNLOAD - (Before a stream input is unloaded, if false keep the stream active)
  • PUSH_OUT_START - (Whenever any push to file/target is started, override the target with response or empty for abort)
  • SYSTEM_START - (When MistServer boots, if false shut down the server)
  • SYSTEM_STOP - (When MistServer shuts down, if false abort shutdown)
  • *STREAM_LOAD - (Right before a stream input is loaded, false to abort loading of input. Obsoleted by STREAM_SOURCE which allows for more control at the same event point.)