Uiza Documentation
2022-06-06
2022-06-06
  • Hola! 👋
  • Getting Started
    • Introduction
    • Authentication
    • Errors
    • Quick Starts
      • Live Streaming
      • Video Streaming
    • Pagination
    • Recommended Specifications
    • Sample Streaming Apps
      • NodeJS Live Streaming App
      • Java Live Streaming App
      • Python Live Streaming App
      • How to integrate live streaming into an Android App using Uiza’s Live API
    • Versioning
  • API Reference
    • Live Entities
      • Create a live entity
      • Retrieve a live entity
      • Update a live entity
      • Delete a live entity
      • List all live entities
      • Create a live relay
      • Update a live relay
      • Delete a live relay
    • Video Entities
      • Create a video entity
      • Retrieve a video entity
      • Update a video entity
      • Delete a video entity
      • List all video entities
    • Events
      • Event Types
    • Webhook Endpoints
      • Verifying signatures
      • Create a webhook endpoint
      • Update a webhook endpoint
      • Get a webhook endpoint
      • List all webhook endpoint
  • SDK REFERENCE
    • Introduction
    • Android SDK
      • Android Player SDK
      • Android Broadcast SDK
    • iOS SDK
      • iOS Player SDK
      • iOS Broadcast SDK
    • Web Player SDK
    • Flutter SDK
  • API UPGRADES
    • Release Notes
    • API Changelog
Powered by GitBook
On this page

Was this helpful?

  1. API Reference

Webhook Endpoints

PreviousEvent TypesNextVerifying signatures

Last updated 2 years ago

Was this helpful?

Webhook provides a mechanism for Uiza to notifies you about the events that happen in your Uiza account. When something interesting happens (a live_entity is created, a ingest.key is reset, a video_entity is deleted, etc.) Uiza creates an event object which contains the details of what just occurred. This event will then be sent to the webhook endpoint, a pre-configured URL where Uiza makes HTTP POST requests to.

A single event could be be sent to multiple webhook endpoints. You could generate endpoint URLs for your tests .

The webhook endpoint object

Attributes

id string

The unique identifier for the object.

url string

The URL of the webhook_endpoint.

status string

Indicates the current status of the webhook_endpoint, which is either disabled or enabled.

signing_secret string

SThe endpoint’s secret, used to generate webhook signature. Only returned at creation.

event_type array

The list of events to enable for this endpoint. [’*’] indicates that all events are enabled, except those that require explicit selection.

created_at string

The timestamp, at which the webhook_endpointis created, follows the .

updated_at string

The timestamp, at which the most recent update to the webhook_endpoint occurred, follows the .

here
ISO 8601 standard
ISO 8601 standard