Uiza Documentation
2021-09-21
2021-09-21
  • 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
  • /v1/webhook
  • /v1/webhook_endpoints

Was this helpful?

  1. API Reference
  2. Webhook Endpoints

Create a webhook endpoint

A URL and a secret are required for webhook endpoint creation. While URLs are endpoints where Uiza sends the events to, secrets are used to generate webhook signatures.

/v1/webhook

POST https://api.uiza.io/api-account/owner/v1/webhook

Set up your webhook endpoint to receive live events from Uiza

Headers

Name
Type
Description

Authentication

string

Authentication token or Api Key

Request Body

Name
Type
Description

url

string

The URL of the webhook endpoint.

event_type

array

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

status

string

The status of the webhook. It can be enabled or disabled.

{
  "data": {
    "event_type":["live_entities.created", "live_entities.ready"],
    "id":"960d2199-f8a2-4f68-99db-3a688bda5db1",
    "url":"https://uiza-example.com/webhook",
    "app_id":"095c81e1-8be8-46f1-9dcb-0f8ad54eac8a",
    "signing_secret":"webhook_8fCc3HaU0a-aJT2szrU7",
    "created_by":"fe57cb55-d73f-4a2a-ada6-280248e995af",
    "updated_at":"2021-09-07T14:22:23.183Z",
    "created_at":"2021-09-07T14:22:23.183Z"
  }
}
Sample Request


curl --location --request POST 'https://api.uiza.io/api-account/owner/v1/webhook/'        
--header 'Content-Type: application/json'  --header 'Authorization: '    
--data-raw '{
  "url": "https://uiza-example.com/webhook",
  "status": "enabled",
  "event_type": [
    "live_entities.created"
  ]
}'

/v1/webhook_endpoints

POST https://api.uiza.sh/v1/webhook_endpoints

Request Body

Name
Type
Description

secret

string

The token used to validate the communication between Uiza and the webhook endpoint.

url

string

The URL of the webhook endpoint.

{
 "id": "f0f207af-b338-4b7f-8d32-fe9cfa9566eb",
 "url": "https://webhook-test.com/live/created",
 "status": "enabled",
 "created_at": "2019-12-16T10:57:32Z",
 "updated_at": "2019-12-16T10:57:32Z"
}
{
 "message": "Your request is missing url parameter. Please, verify and resubmit.",
 "error_type": "invalid_request_error"
}
{
 "message": "You are unauthorized to access the requested resource. Please verify and resubmit.",
 "error_type": "invalid_request_error"
}
{
 "message": "The requested app_id already registered with a webhook.",
 "error_type": "invalid_request_error"
}
{
 "message": "An unexpected error occurred on Uiza's end.",
 "error_type": "api_error"
}
Sample Request
curl -X POST https://api.uiza.sh/v1/webhook_endpoints
     -H 'Authorization: uap-c1ffbff4db954ddcb050c6af0b43ba56-41193b64'
     -d '{"url": "https://webhook-test.com/live/created", "secret": "a-secret"}'

PreviousVerifying signaturesNextUpdate a webhook endpoint

Last updated 3 years ago

Was this helpful?