Webhooks
What are Webhooks?
Webhooks are server-side push notifications that are triggered by specific events within the 3Q platform. They allow external systems to react automatically to changes or actions without the need for polling.
Typical webhook events include:
A video asset has been uploaded or updated
A livestream has started or ended
Processing or encoding states have changed
Configuration
Webhooks can be configured in the Notifications module. For each webhook, the following settings can be defined:
Target URL (endpoint that receives the event)
Secret for request validation
Event types to subscribe to
Once configured, the platform sends an HTTP request to the specified endpoint whenever the selected event occurs.
Example Payload
Webhook requests include event information as URL parameters and a structured JSON payload in the request body.
Example request URL:
Example payload:
Security
Webhook requests can be secured using AWS Cognito signature validation. This allows recipients to verify the authenticity of incoming webhook requests.
AWS Cognito can be connected to the 3Q platform in Account → Partners & Services. Once configured, webhook requests will be signed accordingly.
Last updated