Webhooks allow the sending of real-time data from one application to another whenever a given event occurs.
Quortex I/O offers webhooks to notify third-party systems of internal events.
Messages can be formatted according to the guidelines of popular applications (Google Chat, Slack, or Teams) or kept as raw JSON content for other purposes.

Which events are notified ?

All events listed in the "Event log" area of the UI can be notified.

Event logs are generated whenever a Quortex resource is impacted, such as when a configuration is created, updated, or deleted. Changes in the status of pools and inputs/streams are also notified. The following event categories are used to track every impacted resource according to its type. This also allows filtering notifications for specific events.

Specific to Quortex Play

• input
• stream
• target
• publishing_points
• processing
• access
• program
• drm_merchant
• vod_asset
• push_endpoint
  
  Specific to Quortex Link
• source
• destination
• sender
• receiver
• input_stream
• output_stream
• scheduled_event
  
  Operational status changes
• input_status (a status exists for each stream belonging to an input)
• pool_status

Related to the Organization

• organization
• membership
• user
• api_key
  
  Related to the Billing
• payment
• plan
• service

Creating a webhook

A webhook is primarily defined by a name and a destination URL. Additional settings allow you to specify the format of the message (Google Chat, Slack, Teams, or raw). You can optionally filter by a specific pool (typically to focus on your production service), as well as by categories to select the types of events you need to receive.

The detailed API documentation can be found here.
Please note that managing webhooks requires an API Key defined at Organization level, which can be generated with Admin role, from the Settings menu.

As an example, here's the body request to create a webhook sending raw formatted notifications to a webhook.site channel, filtered on a specific pool-uuid :

New event logs generated by Quortex on the selected pool lead to immediate notifications to the webhook.site channel as illustrated below:

Updated on: 08/08/2024