Skip to content

Latest commit

 

History

History
253 lines (176 loc) · 11.6 KB

WebhooksApi.md

File metadata and controls

253 lines (176 loc) · 11.6 KB

apivideo.WebhooksApi

All URIs are relative to https://ws.api.video

Method HTTP request Description
create POST /webhooks Create Webhook
get GET /webhooks/{webhookId} Retrieve Webhook details
delete DELETE /webhooks/{webhookId} Delete a Webhook
list GET /webhooks List all webhooks

create

Webhook create(webhooks_creation_payload)

Create Webhook

Webhooks can push notifications to your server, rather than polling api.video for changes. We currently offer four events: * video.encoding.quality.completed Occurs when a new video is uploaded into your account, it will be encoded into several different HLS and mp4 qualities. When each version is encoded, your webhook will get a notification. It will look like { \"type\": \"video.encoding.quality.completed\", \"emittedAt\": \"2021-01-29T16:46:25.217+01:00\", \"videoId\": \"viXXXXXXXX\", \"encoding\": \"hls\", \"quality\": \"720p\"} . This request says that the 720p HLS encoding was completed. * live-stream.broadcast.started When a live stream begins broadcasting, the broadcasting parameter changes from false to true, and this webhook fires. * live-stream.broadcast.ended This event fires when a live stream has finished broadcasting. * video.source.recorded This event occurs when a live stream is recorded and submitted for encoding. * video.caption.generated This event occurs when an automatic caption has been generated. * video.summary.generated This event occurs when an automatic summary has been generated.

Example

import apivideo
from apivideo.api import webhooks_api
from apivideo.model.too_many_requests import TooManyRequests
from apivideo.model.bad_request import BadRequest
from apivideo.model.webhook import Webhook
from apivideo.model.webhooks_creation_payload import WebhooksCreationPayload
from pprint import pprint

# Enter a context with an instance of the API client
with apivideo.AuthenticatedApiClient(__API_KEY__) as api_client:
    # Create an instance of the API class
    api_instance = webhooks_api.WebhooksApi(api_client)
    webhooks_creation_payload = WebhooksCreationPayload(
        events=["video.encoding.quality.completed"],
        url="https://example.com/webhooks",
    ) # WebhooksCreationPayload | 

    # example passing only required values which don't have defaults set
    try:
        # Create Webhook
        api_response = api_instance.create(webhooks_creation_payload)
        pprint(api_response)
    except apivideo.ApiException as e:
        print("Exception when calling WebhooksApi->create: %s\n" % e)

Parameters

Name Type Description Notes
webhooks_creation_payload WebhooksCreationPayload

Return type

Webhook

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Created * X-RateLimit-Limit - The request limit per minute.
* X-RateLimit-Remaining - The number of available requests left for the current time window.
* X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
400 Bad Request * X-RateLimit-Limit - The request limit per minute.
* X-RateLimit-Remaining - The number of available requests left for the current time window.
* X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429 Too Many Requests * X-RateLimit-Limit - The request limit per minute.
* X-RateLimit-Remaining - The number of available requests left for the current time window.
* X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get

Webhook get(webhook_id)

Retrieve Webhook details

Retrieve webhook details by id.

Example

import apivideo
from apivideo.api import webhooks_api
from apivideo.model.too_many_requests import TooManyRequests
from apivideo.model.webhook import Webhook
from pprint import pprint

# Enter a context with an instance of the API client
with apivideo.AuthenticatedApiClient(__API_KEY__) as api_client:
    # Create an instance of the API class
    api_instance = webhooks_api.WebhooksApi(api_client)
    webhook_id = "webhookId_example" # str | The unique webhook you wish to retreive details on.

    # example passing only required values which don't have defaults set
    try:
        # Retrieve Webhook details
        api_response = api_instance.get(webhook_id)
        pprint(api_response)
    except apivideo.ApiException as e:
        print("Exception when calling WebhooksApi->get: %s\n" % e)

Parameters

Name Type Description Notes
webhook_id str The unique webhook you wish to retreive details on.

Return type

Webhook

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success * X-RateLimit-Limit - The request limit per minute.
* X-RateLimit-Remaining - The number of available requests left for the current time window.
* X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429 Too Many Requests * X-RateLimit-Limit - The request limit per minute.
* X-RateLimit-Remaining - The number of available requests left for the current time window.
* X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete

delete(webhook_id)

Delete a Webhook

This method will delete the indicated webhook.

Example

import apivideo
from apivideo.api import webhooks_api
from apivideo.model.too_many_requests import TooManyRequests
from apivideo.model.not_found import NotFound
from pprint import pprint

# Enter a context with an instance of the API client
with apivideo.AuthenticatedApiClient(__API_KEY__) as api_client:
    # Create an instance of the API class
    api_instance = webhooks_api.WebhooksApi(api_client)
    webhook_id = "webhookId_example" # str | The webhook you wish to delete.

    # example passing only required values which don't have defaults set
    try:
        # Delete a Webhook
        api_instance.delete(webhook_id)
    except apivideo.ApiException as e:
        print("Exception when calling WebhooksApi->delete: %s\n" % e)

Parameters

Name Type Description Notes
webhook_id str The webhook you wish to delete.

Return type

void (empty response body)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 No Content * X-RateLimit-Limit - The request limit per minute.
* X-RateLimit-Remaining - The number of available requests left for the current time window.
* X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
404 Not Found * X-RateLimit-Limit - The request limit per minute.
* X-RateLimit-Remaining - The number of available requests left for the current time window.
* X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429 Too Many Requests * X-RateLimit-Limit - The request limit per minute.
* X-RateLimit-Remaining - The number of available requests left for the current time window.
* X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

WebhooksListResponse list()

List all webhooks

Thie method returns a list of your webhooks (with all their details).

You can filter what the webhook list that the API returns using the parameters described below.

Example

import apivideo
from apivideo.api import webhooks_api
from apivideo.model.too_many_requests import TooManyRequests
from apivideo.model.webhooks_list_response import WebhooksListResponse
from pprint import pprint

# Enter a context with an instance of the API client
with apivideo.AuthenticatedApiClient(__API_KEY__) as api_client:
    # Create an instance of the API class
    api_instance = webhooks_api.WebhooksApi(api_client)
    events = "video.encoding.quality.completed" # str | The webhook event that you wish to filter on. (optional)
    current_page = 2 # int | Choose the number of search results to return per page. Minimum value: 1 (optional) if omitted the server will use the default value of 1
    page_size = 30 # int | Results per page. Allowed values 1-100, default is 25. (optional) if omitted the server will use the default value of 25

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # List all webhooks
        api_response = api_instance.list(events=events, current_page=current_page, page_size=page_size)
        pprint(api_response)
    except apivideo.ApiException as e:
        print("Exception when calling WebhooksApi->list: %s\n" % e)

Parameters

Name Type Description Notes
events str The webhook event that you wish to filter on. [optional]
current_page int Choose the number of search results to return per page. Minimum value: 1 [optional] if omitted the server will use the default value of 1
page_size int Results per page. Allowed values 1-100, default is 25. [optional] if omitted the server will use the default value of 25

Return type

WebhooksListResponse

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Success * X-RateLimit-Limit - The request limit per minute.
* X-RateLimit-Remaining - The number of available requests left for the current time window.
* X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.
429 Too Many Requests * X-RateLimit-Limit - The request limit per minute.
* X-RateLimit-Remaining - The number of available requests left for the current time window.
* X-RateLimit-Retry-After - The number of seconds left until the current rate limit window resets.

[Back to top] [Back to API list] [Back to Model list] [Back to README]